forked from tmrts/go-patterns
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CONTRIBUTING: extend the contribution guidelines
- Loading branch information
Showing
1 changed file
with
27 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |