Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Update contributing guide #35

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[DOC] Update contributing guide #35

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b6c23e
[DOC] Update contributing guide
serhiislobodian Nov 26, 2018
97a45ea
[DOC] Contributing guide
serhiislobodian Nov 27, 2018
7722072
Merge branch 'master' into doc-contribution-guide
serhiislobodian Mar 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,26 +56,41 @@ Then write detailed commit message describing what changes you made in the commi

### Bug Fixes

In general bug fixes are pulled into the branch.
As such, the prefix is: `[BUGFIX]`.
In general bug fixes are pulled into the branch with the `[BUGFIX]` prefix.
If a bug fix is a serious regression that requires a new patch release,
`[BUGFIX release]` can be used instead.

### Build

Build commits are chenges that affect the build system, CI or external dependencies and should be tagged as `[BUILD]`.

### Cleanup

Cleanup commits are for removing deprecated functionality and should be tagged as `[CLEANUP]`.

### Documentation

Documentation commits are tagged as `[DOC]`.

### Features

All additions and fixes for features should be tagged as `[FEATURE]`

### Documentation
### Performance

Documentation commits are tagged as `[DOC]`.
Performance commits are those responsible for execution speed, memory usage, etc and should be tagged as `[PERFORM]`.

### Refactor

Code changes that are neither bug fixes nor features or improvements should be committed and tagged as `[REFACTOR]`.

### Test

Commits responsible for correcting existing tests or adding new ones should be tagged as `[TEST]`.

### Other

In general, almost all commits should fall into one of these categories and have corresponding tag.
In general, almost all commits should fall into one of these categories and have the corresponding tag.
In cases when commits can't match any category, please submit your PR untagged.

## Contribution Checklist
Expand All @@ -89,4 +104,4 @@ In cases when commits can't match any category, please submit your PR untagged.
#### Licensing of Contributions
****
All contributions must be licensed with the [APACHE license](LICENCE).
This is the same license as all of the code found within Peach wallet.
This is the same license as all of the code found within Peach wallet.