From 4b81980a1f86625f4169b1b041ecb0a3aa24f22c Mon Sep 17 00:00:00 2001 From: Tamer Tas Date: Tue, 6 Sep 2016 19:27:15 +0300 Subject: [PATCH] CONTRIBUTING: extend the contribution guidelines --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aaff070..7ae7acb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 `/: ` (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 +# + + +## Implementation + +## Usage + +// Optional +## Rules of Thumb +```