Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 2.56 KB
Raw

Contributing

Thanks for Looking to contribute to the Awesome-Repos. We are happy to see your interest for crafting a great Pull Request for this project.

Formatting

Please follow the format given below while making a new entry in the README.

Repository Description License
Repository Name(Link to the repository) Original Description mention in the About section of the repository(Include the emojis as well, if any. ) License Name(Link to the License)

Example entry:

| [Awesome](https://github.com/sindresorhus/awesome) | 😎 Awesome lists about all kinds of interesting topics | [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode) |


Guidelines

  • Continue to follow the alphabetical ordering that is in place per section.

  • Each table column should be padded with one space on either side.

  • Make sure the repository has quality content, to do so look at the stars the repository has received.

  • Add one link per Pull Request.

  • Make sure the PR title is in the format of Add repository-name for e.g.: Add awesome-python

  • Use a short descriptive commit message. for e.g.: ❌Update README.md ✔Add Git to the CheatSheets

  • Search previous Pull Requests or Issues before making a new one, as yours may be a duplicate.

  • Don't mention "Awesome" in the repository name while adding a link in the README, if you are adding an awesome repository . for e.g.: ❌Awesome-Python ✔Python

  • If the repository has No License, simply add No License to the License column.

  • If the repository is having Creative Commons License

    • CC0-1.0 include the hyperlink https://creativecommons.org/publicdomain/zero/1.0/legalcode to the License.

    • CC-BY-4.0 include the hyperink https://creativecommons.org/licenses/by/4.0/legalcode to the License.


Pull Request Pro Tips

  • Fork the repository and clone it locally.
  • Contribute in the style of the project as outlined above. This makes it easier to understand and maintain in the future.
  • Please make sure you squash all commits into a single commit before opening a pull request. If your pull request requires changes upon review, please be sure to squash all additional commits as well.

Thanks you so much for reading the contributing guide. Looking forward to review a great PR from you.