You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
:clap::tada: Thank you for taking the time to contribute! :tada::clap:
3
+
4
+
We really value your willingness to contribute to this project. In order to higher the chances of your contribution being accepted, please refer to the following guidelines!
5
+
6
+
## Steps
7
+
8
+
1. Fork it!
9
+
2. Create your feature branch: `git checkout -b feature/xyz develop`
10
+
3. Commit your changes according to our commit message standards: `git commit -am 'feat(xyz) Added new functionality'`
11
+
4. Push to your repo: `git push origin feature/xyz`
12
+
5. Submit a pull request to `develop`
13
+
14
+
## Workflow
15
+
This repo uses Gitflow as its branch management system. You can learn more about Gitflow [here](https://www.atlassian.com/git/tutorials/comparing-workflows#gitflow-workflow).
16
+
A few quick tips:
17
+
* All feature branches should be based on `develop` and have the format `feature/branch_name`.
18
+
* Minor bug fixes should be based on `master` and have the format `hotfix/branch_name`.
19
+
20
+
### Commit Conventions
21
+
In order to make the changelog generation easier we recommend the use of messages based on [Conventional Commits](https://conventionalcommits.org/).
22
+
23
+
Examples:
24
+
```
25
+
feat(orders): added `XYZ` helper function
26
+
27
+
commit description
28
+
29
+
footer notes
30
+
```
31
+
32
+
```
33
+
refactor(orders): refactored `ABC` helper function
34
+
35
+
The behaviour of `ABC` was inconsistent and (...)
36
+
37
+
BREAKING CHANGE: return type of `ABC` is now `String`
0 commit comments