mirror/awesome-patterns
1
0
Fork 0
mirror of https://github.com/crazybber/awesome-patterns.git synced 2024-11-22 04:36:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: extend the contribution guidelines

Browse Source
This commit is contained in:
Tamer Tas 2016-09-06 19:27:15 +03:00
parent 077bcecea0
commit 4b81980a1f
1 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -1,6 +1,31 @@
# Contribution Guidelines
Please ensure your pull request adheres to the following guidelines:
- Make an individual pull request for each suggestion.
- Choose the corresponding section of patterns for your suggestion.
- List, after your addition, should be alphabetically.
- Choose the corresponding patterns section for your suggestion.
- List, after your addition, should be in lexicographical order.
## Commit Messages Guidelines
- The message should be in imperative form and uncapitalized.
- If possible, please include an explanation in the commit message body
- Use the form `<pattern-section>/<pattern-name>: <message>` (e.g. `creational/singleton: refactor singleton constructor`)
## Pattern Template
Each pattern should have a single markdown file containing the important part of the implementation, the usage and the explanations for it. This is to ensure that the reader doesn't have to read bunch of boilerplate to understand what's going on and the code is as simple as possible and not simpler.
Please use the following template for adding new patterns:
```markdown
# <Pattern-Name>
<Pattern description>
## Implementation
## Usage
// Optional
## Rules of Thumb
```