Skip to content

Commit 4b81980

Browse files
committed
CONTRIBUTING: extend the contribution guidelines
1 parent 077bcec commit 4b81980

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,31 @@
11
# Contribution Guidelines
2+
23
Please ensure your pull request adheres to the following guidelines:
34

45
- Make an individual pull request for each suggestion.
5-
- Choose the corresponding section of patterns for your suggestion.
6-
- List, after your addition, should be alphabetically.
6+
- Choose the corresponding patterns section for your suggestion.
7+
- List, after your addition, should be in lexicographical order.
8+
9+
## Commit Messages Guidelines
10+
11+
- The message should be in imperative form and uncapitalized.
12+
- If possible, please include an explanation in the commit message body
13+
- Use the form `<pattern-section>/<pattern-name>: <message>` (e.g. `creational/singleton: refactor singleton constructor`)
14+
15+
## Pattern Template
16+
17+
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.
18+
19+
Please use the following template for adding new patterns:
20+
21+
```markdown
22+
# <Pattern-Name>
23+
<Pattern description>
24+
25+
## Implementation
26+
27+
## Usage
28+
29+
// Optional
30+
## Rules of Thumb
31+
```

0 commit comments

Comments
 (0)