Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

25 lines (21 loc) · 2.34 KB
Raw

Contribution Guidelines

Please ensure that your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make sure your contribution is useful and relevant before submitting. That implies it has enough content and every item has a good succinct description.
  • Make an individual pull request for each suggestion.
  • Use the following format: - [Repository Name](link-to-repository-label) _(label: beginner-friendly-label-in-the-repository)_ <br> Description
  • Example link formatting: - [awesome-for-beginners](https://github.com/MunGell/awesome-for-beginners/labels/good-first-contribution) _(label: good-first-contribution)_ <br> A list of awesome beginners-friendly projects.
  • Link additions should be added to the bottom of the relevant category.
  • New categories or improvements to the existing categorization are welcome.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request and commit should be given a meaningful title.
  • Ensure that you describe your pull request.
  • If the label does not clearly state it's "beginner friendly" purpose, please make sure to confirm with the maintainer that it is used for such issues. Please include the link to where the maintainer approves it in the PR. See examples below:
    • Repository called "HornsAndHoovesJs" has label good-first-contribution. This PR does not need to be confirmed with the maintainer and can be merged straight away.
    • Repository called "bicycle-wheels-php" has label easy. This PR must be confirmed with the maintainer of "bicycle-wheels-php". The issue link where the maintainer confirms that label easy is used in the repository for beginner-friendly tasks has to be provided in the PR description.
  • Maintainer confirmation is also required in case repository has more than one beginner-friendly-like label (e.g. low-hanging-fruit and up-for-grabs).
  • The contributed repository must be maintained, have an active community to be able to help newcomers and have issues with an appropriate label.
  • Links must be pointing directly to the repository, no tracking links allowed. This list is not for advertising purposes.

Thank you for your suggestions!

(This file was partially copied from awesome-speaking)