lib/awesome-design-patterns
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update contributing.md

Browse Source
This commit is contained in:
Dov Amir
2018-06-11 18:13:22 +03:00
committed by GitHub
parent f6645117f0
commit aae19a75e3
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
contributing.md
View File

@@ -2,16 +2,16 @@
Please ensure your pull request adheres to the following guidelines: Please ensure your pull request adheres to the following guidelines:
- Good design patterns resources should describe and explain several patterns (not describe a singal pattern only).
- Search previous suggestions before making a new one, as yours may be a duplicate. - Search previous suggestions before making a new one, as yours may be a duplicate.
- Use the following format: `[name](link) - Description.` - Use the following format: `[name](link) - Description.`
- New categories, or improvements to the existing categorization are welcome. - New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive. - Keep descriptions short and simple, but descriptive.
- End all descriptions with a full stop/period. - End all descriptions with a full stop/period.
- Check your spelling and grammar. - Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request should include a link to the package and why it should be included. - The pull request should include a link to the package and why it should be included.
- Patterns should be software related - Patterns should be software related
- Good design patterns resources should have at least 5 patterns with detailed descriptions.
Thank you for your suggestions! Thank you for your suggestions!
@@ -22,3 +22,5 @@ Thank you for your suggestions!
- Commit your changes: git commit -am 'fix stuff' - Commit your changes: git commit -am 'fix stuff'
- Push to the branch: git push origin my-new-branch - Push to the branch: git push origin my-new-branch
- Submit a pull request - Submit a pull request
(or manually edit the readme file in github and create a pull request)