From 8b6c23e1ea427065bbcdf5c32e100ffc62a5878c Mon Sep 17 00:00:00 2001 From: Serhii Slobodian Date: Mon, 26 Nov 2018 17:54:17 +0200 Subject: [PATCH 1/2] [DOC] Update contributing guide --- CONTRIBUTING.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f28f23df3..8a88276f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,17 +61,33 @@ As such, the prefix is: `[BUGFIX]`. 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 commited and tagged as `[REFACTOR]`. + +### Test + +Commits responsible for correcting existing tests or adding new ones should be tagged as `[TEST]`. ### Other @@ -89,4 +105,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. \ No newline at end of file +This is the same license as all of the code found within Peach wallet. From 97a45ea53d9943557d9c1cbeb8ea3a8001466dda Mon Sep 17 00:00:00 2001 From: Serhii Slobodian Date: Tue, 27 Nov 2018 12:47:28 +0200 Subject: [PATCH 2/2] [DOC] Contributing guide Fix lexical errors --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a88276f5..58dabf303 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,8 +56,7 @@ 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. @@ -83,7 +82,7 @@ Performance commits are those responsible for execution speed, memory usage, etc ### Refactor -Code changes that are neither bug fixes nor features or improvements should be commited and tagged as `[REFACTOR]`. +Code changes that are neither bug fixes nor features or improvements should be committed and tagged as `[REFACTOR]`. ### Test @@ -91,7 +90,7 @@ Commits responsible for correcting existing tests or adding new ones should be t ### 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