Skip to content

Commit 25ba3f7

Browse files
Update CONTRIBUTING.md
Add write up for developing guide
1 parent d644dcb commit 25ba3f7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ email, or any other method with the owners of this repository before making a ch
55

66
Please note we have a code of conduct, please follow it in all your interactions with the project.
77

8+
## Developing Project
9+
You consider contributing to this project – thank you! Please consider these guidelines when creating a commit:
10+
11+
1. The commit message should flow the convention - we use commitzen to handle this, ensure it's installed before you proceed.
12+
2. Appropiate terminology should be choosen for the representing the commit ( feat, fix, refactor, chore etc.)
13+
3. The commit message should be brief & verbose.
14+
4. Features and bug fixes should be covered by test cases ( No PR will be merged without them ! )
15+
816
## Pull Request Process
917

1018
1. Ensure any install or build dependencies are removed before the end of the layer when doing a

0 commit comments

Comments
 (0)