personal_interest_mirrors/awesome
1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome.git synced 2025-11-08 22:34:22 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
awesome/contributing.md
Vishwanath Martur fdbf48b097 Add CI to automate heavy PR load 
Related to #1365

Implement CI to automate heavy PR load using `awesome-lint`.

* **.github/workflows/main.yml**
  - Add a step to run `awesome-lint` on `readme.md` after the checkout step.
* **.github/workflows/repo_linter.sh**
  - Add `npx awesome-lint` command to lint the repository after cloning.
* **readme.md**
  - Mention the usage of `awesome-lint` for CI in the introduction.
  - Add a section about `awesome-lint` in the "Contribution guide".
* **contributing.md**
  - Add instructions for running `awesome-lint` before submitting a PR.
  - Mention the requirement to pass `awesome-lint` in the PR guidelines.
2025-03-09 23:46:28 +05:30

2.5 KiB
Raw Blame History

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Adding an awesome list

Please ensure your pull request adheres to the list of guidelines.

Creating your own awesome list

To create your own list, check out the instructions.

Adding something to an awesome list

If you have something awesome to contribute to an awesome list, this is how you do it.

You'll need a GitHub account!

  1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
  2. Click on the readme.md file: Step 2 Click on Readme.md
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow the guidelines above. You can use GitHub Flavored Markdown. Step 4 - Edit the file
  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  6. Submit the pull request!

Updating your Pull Request

Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.

Here is a write up on how to change a Pull Request and the different ways you can do that.

Running awesome-lint before submitting a PR

Before submitting a pull request, please ensure that your changes pass the awesome-lint checks. This helps maintain the quality and consistency of the repository.

To run awesome-lint, use the following command:

npx awesome-lint

Pull Request Guidelines

  • Ensure your pull request adheres to the list of guidelines.
  • Your pull request must pass the awesome-lint checks.