wucket/awesome-for-beginners
1
0
Fork 0
mirror of https://github.com/MunGell/awesome-for-beginners.git synced 2025-12-13 09:42:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #65 from MunGell/docs/contributing-update

Browse Source 
Update CONTRIBUTING.md
This commit is contained in:
Shmavon Gazanchyan 2017-01-06 08:14:35 +00:00 committed by GitHub
commit 1420b6c908
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -3,15 +3,21 @@
Please ensure 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 list is useful before submitting. That implies it having enough content and every item a good succinct description.
- Make sure your contribution is useful and relevant before submitting. That implies it having enough content and every item a good succinct description.
- Make an individual pull request for each suggestion.
- Use the following format: `[List Name](link)`
- Use the following format: `- [Repository Name](link-to-repository) _(beginner-friendly-label-in-the-repository)_ <br> Description`
- 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 have a useful title.
- If label does not clearly state it's "beginner friendly" purpose, please make sure to confirm with maintainer that it is used for such issues. Please include the link to where maintainer confirms 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". Link to the issue where 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`).
- Contributed repository must be maintained, have active community to be able to help newcomers and have issues with 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 mostly copied from [awesome-speaking](https://github.com/matteofigus/awesome-speaking))
(this file was partially copied from [awesome-speaking](https://github.com/matteofigus/awesome-speaking))