-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update contributing guidelines (#859)
* update PR templates * update contributing guidelines * apply review suggestions * Update CONTRIBUTING.md Co-authored-by: Shawn <[email protected]> * apply review suggestions * apply review suggestions * Update CONTRIBUTING.md Co-authored-by: MSalopek <[email protected]> * apply review suggestions --------- Co-authored-by: Shawn <[email protected]> Co-authored-by: MSalopek <[email protected]>
- Loading branch information
3 people
authored
Apr 20, 2023
1 parent
871bd19
commit 8763d99
Showing
4 changed files
with
271 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,49 @@ | ||
| # Description | ||
| <!-- | ||
| The default pull request template is for types feat, fix, or refactor. | ||
| For other templates, add one of the following parameters to the url: | ||
| - template=docs.md | ||
| - template=other.md | ||
| --> | ||
|
|
||
| Please include a summary of the changes and the related issue. If the issue was ambiguous try to clarify it in this section. | ||
| ## Description | ||
|
|
||
| ## Linked issues | ||
| Closes: #XXXX | ||
|
|
||
| Closes: `#<issue>` | ||
| <!-- Add a description of the changes that this PR introduces and the files that | ||
| are the most critical to review. --> | ||
|
|
||
| ## Type of change | ||
| --- | ||
|
|
||
| If you've checked more than one of the first three boxes, consider splitting this PR into multiple PRs! | ||
| ### Author Checklist | ||
|
|
||
| - [ ] `Feature`: Changes and/or adds code behavior, irrelevant to bug fixes | ||
| - [ ] `Fix`: Changes and/or adds code behavior, specifically to fix a bug | ||
| - [ ] `Refactor`: Changes existing code style, naming, structure, etc. | ||
| - [ ] `Testing`: Adds testing | ||
| - [ ] `Docs`: Adds documentation | ||
| *All items are required. Please add a note to the item if the item is not applicable and | ||
| please add links to any relevant follow up issues.* | ||
|
|
||
| ## Regression tests | ||
| I have... | ||
|
|
||
| If `Refactor`, describe the new or existing tests that verify no behavior was changed or added where refactors were introduced. | ||
| * [ ] Included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
| * [ ] Added `!` to the type prefix if API or client breaking change | ||
| * [ ] Targeted the correct branch (see [PR Targeting](https://github.com/cosmos/interchain-security/blob/main/CONTRIBUTING.md#pr-targeting)) | ||
| * [ ] Provided a link to the relevant issue or specification | ||
| * [ ] Followed the guidelines for [building SDK modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules) | ||
| * [ ] Included the necessary unit and integration [tests](https://github.com/cosmos/interchain-security/blob/main/CONTRIBUTING.md#testing) | ||
| * [ ] Added a changelog entry to `CHANGELOG.md` | ||
| * [ ] Included comments for [documenting Go code](https://blog.golang.org/godoc) | ||
| * [ ] Updated the relevant documentation or specification | ||
| * [ ] Reviewed "Files changed" and left comments if necessary <!-- relevant if the changes are not obvious --> | ||
| * [ ] Confirmed all CI checks have passed | ||
|
|
||
| ## New behavior tests | ||
| ### Reviewers Checklist | ||
|
|
||
| If `Feature` or `Fix`, describe the new or existing tests that verify the new behavior is correct and expected. | ||
| *All items are required. Please add a note if the item is not applicable and please add | ||
| your handle next to the items reviewed if you only reviewed selected items.* | ||
|
|
||
| ## Versioning Implications | ||
| I have... | ||
|
|
||
| - [ ] This PR will affect [semantic versioning as defined for ICS](../CONTRIBUTING.md#semantic-versioning) | ||
|
|
||
| If the above box is checked, which version should be bumped? | ||
|
|
||
| - [ ] `MAJOR`: Consensus breaking changes to both the provider and consumers(s), including updates/breaking changes to IBC communication between provider and consumer(s) | ||
| - [ ] `MINOR`: Consensus breaking changes which affect either only the provider or only the consumer(s) | ||
| - [ ] `PATCH`: Non consensus breaking changes | ||
|
|
||
| ## Targeting | ||
|
|
||
| Please select one of the following: | ||
|
|
||
| - [ ] This PR is only relevant to main | ||
| - [ ] This PR is relevant to main, and should also be back-ported to ____ (ex: v1.0.0 and v1.1.0) | ||
| - [ ] This PR is only relevant to ____ (ex: v1.0.0, v1.1.0, and v1.2.0) | ||
| * [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
| * [ ] confirmed `!` in the type prefix if API or client breaking change | ||
| * [ ] confirmed all author checklist items have been addressed | ||
| * [ ] reviewed state machine logic | ||
| * [ ] reviewed API design and naming | ||
| * [ ] reviewed documentation is accurate | ||
| * [ ] reviewed tests and test coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| ## Description | ||
|
|
||
| Closes: #XXXX | ||
|
|
||
| <!-- Add a description of the changes that this PR introduces and the files that | ||
| are the most critical to review. --> | ||
|
|
||
| --- | ||
|
|
||
| ### Author Checklist | ||
|
|
||
| *All items are required. Please add a note to the item if the item is not applicable and | ||
| please add links to any relevant follow up issues.* | ||
|
|
||
| I have... | ||
|
|
||
| - [ ] included the correct `docs:` prefix in the PR title | ||
| - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/interchain-security/blob/main/CONTRIBUTING.md#pr-targeting)) | ||
| - [ ] provided a link to the relevant issue or specification | ||
| - [ ] reviewed "Files changed" and left comments if necessary <!-- relevant if the changes are not obvious --> | ||
| - [ ] confirmed all CI checks have passed | ||
|
|
||
| ### Reviewers Checklist | ||
|
|
||
| *All items are required. Please add a note if the item is not applicable and please add | ||
| your handle next to the items reviewed if you only reviewed selected items.* | ||
|
|
||
| I have... | ||
|
|
||
| - [ ] Confirmed the correct `docs:` prefix in the PR title | ||
| - [ ] Confirmed all author checklist items have been addressed | ||
| - [ ] Confirmed that this PR only changes documentation | ||
| - [ ] Reviewed content for consistency | ||
| - [ ] Reviewed content for spelling and grammar | ||
| - [ ] Tested instructions (if applicable) | ||
| - [ ] Checked that the documentation website can be built and deployed successfully (run `make build-docs`) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| ## Description | ||
|
|
||
| Closes: #XXXX | ||
|
|
||
| <!-- Add a description of the changes that this PR introduces and the files that | ||
| are the most critical to review. --> | ||
|
|
||
| --- | ||
|
|
||
| ### Author Checklist | ||
|
|
||
| *All items are required. Please add a note to the item if the item is not applicable and | ||
| please add links to any relevant follow up issues.* | ||
|
|
||
| I have... | ||
|
|
||
| - [ ] Included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
| - [ ] Targeted the correct branch (see [PR Targeting](https://github.com/cosmos/interchain-security/blob/main/CONTRIBUTING.md#pr-targeting)) | ||
| - [ ] Provided a link to the relevant issue or specification | ||
| - [ ] Reviewed "Files changed" and left comments if necessary <!-- relevant if the changes are not obvious --> | ||
| - [ ] Confirmed all CI checks have passed | ||
|
|
||
| ### Reviewers Checklist | ||
|
|
||
| *All items are required. Please add a note if the item is not applicable and please add | ||
| your handle next to the items reviewed if you only reviewed selected items.* | ||
|
|
||
| I have... | ||
|
|
||
| - [ ] Confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
| - [ ] Confirmed all author checklist items have been addressed | ||
| - [ ] Confirmed that this PR does not change production code <!-- e.g., updating tests --> |
Oops, something went wrong.