-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* init * build fixed * updated to latest changes * github workflows
- Loading branch information
Showing
27 changed files
with
1,181 additions
and
0 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 |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: Create a report to help us squash bugs! | ||
| title: "[Bug]: " | ||
| labels: "T:Bug" | ||
| --- | ||
|
|
||
| <!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ | ||
| v ✰ Thanks for opening an issue! ✰ | ||
| v Before smashing the submit button please review the template. | ||
| v Please also ensure that this is not a duplicate issue :) | ||
| ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> | ||
|
|
||
| <!-- | ||
| IMPORTANT: Prior to opening a bug report, check if it affects one of the core modules | ||
| and if its elegible for a bug bounty on `SECURITY.md`. Bugs that are not submitted | ||
| through the appropriate channels won't receive any bounty. | ||
| --> | ||
|
|
||
| ## Summary of Bug | ||
|
|
||
| <!-- Concisely describe the issue --> | ||
|
|
||
| ## Version | ||
|
|
||
| <!-- git commit hash or release version --> | ||
|
|
||
| ## Steps to Reproduce | ||
|
|
||
| <!-- What commands in order should someone run to reproduce your problem? --> |
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,31 @@ | ||
| --- | ||
| name: Epic | ||
| about: Create an epic/user | ||
| title: "[Epic]: " | ||
| labels: T:Epic | ||
| --- | ||
|
|
||
| <!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ | ||
| v ✰ Thanks for opening an issue! ✰ | ||
| v Before smashing the submit button please review the template. | ||
| v Word of caution: poorly thought-out proposals may be rejected | ||
| v without deliberation | ||
| ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> | ||
|
|
||
| ## Summary | ||
|
|
||
| <!-- Short, concise description of the proposed feature/changes to the repository | ||
| What are the user needs? | ||
| How could this solution fix the user facing problem? --> | ||
|
|
||
| ## Problem Definition | ||
|
|
||
| <!-- Why do we need this feature? | ||
| What problems may be addressed by introducing this feature? | ||
| What benefits does the SDK stand to gain by including this feature? | ||
| Are there any disadvantages of including this feature? --> | ||
|
|
||
| ## Work Breakdown | ||
|
|
||
| <!-- Break the work into many bullet points that will later be turned into issues that can be assigned to developers to work on | ||
| This work may been to be broken up into phases of work in order to better organize when and how things get done. --> |
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,28 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Create a proposal to request a feature | ||
| title: "[Feature]: " | ||
| labels: T:feature-request | ||
| --- | ||
|
|
||
| <!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ | ||
| v ✰ Thanks for opening an issue! ✰ | ||
| v Before smashing the submit button please review the template. | ||
| v Word of caution: poorly thought-out proposals may be rejected | ||
| v without deliberation | ||
| ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> | ||
|
|
||
| ## Summary | ||
|
|
||
| <!-- Short, concise description of the proposed feature --> | ||
|
|
||
| ## Problem Definition | ||
|
|
||
| <!-- Why do we need this feature? | ||
| What problems may be addressed by introducing this feature? | ||
| What benefits does the SDK stand to gain by including this feature? | ||
| Are there any disadvantages of including this feature? --> | ||
|
|
||
| ## Proposal | ||
|
|
||
| <!-- Detailed description of requirements of implementation --> |
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,40 @@ | ||
| --- | ||
| name: Module Readiness Checklist | ||
| about: Pre-flight checklist that modules must pass in order to be included in a release of the Cosmos SDK | ||
| labels: 'module-readiness-checklist' | ||
| --- | ||
|
|
||
| ## x/{MODULE_NAME} Module Readiness Checklist | ||
|
|
||
| This checklist is to be used for tracking the final internal audit of new Cosmos SDK modules prior to inclusion in a published release. | ||
|
|
||
| ### Release Candidate Checklist | ||
|
|
||
| The following checklist should be gone through once the module has been fully implemented. This audit should be performed directly on `main`, or preferably on a `alpha` or `beta` release tag that includes the module. | ||
|
|
||
| The module **should not** be included in any Release Candidate tag until it has passed this checklist. | ||
|
|
||
| - [ ] API audit (at least 1 person) (@assignee) | ||
| - [ ] Are Msg and Query methods and types well-named and organized? | ||
| - [ ] Is everything well documented (inline godoc as well as the spec [README.md](https://github.com/cosmos/cosmos-sdk/blob/main/docs/spec/SPEC-SPEC.md) in module directory) | ||
| - [ ] State machine audit (at least 2 people) (@assignee1, @assignee2) | ||
| - [ ] Read through MsgServer code and verify correctness upon visual inspection | ||
| - [ ] Ensure all state machine code which could be confusing is properly commented | ||
| - [ ] Make sure state machine logic matches Msg method documentation | ||
| - [ ] Ensure that all state machine edge cases are covered with tests and that test coverage is sufficient (at least 90% coverage on module code) | ||
| - [ ] Assess potential threats for each method including spam attacks and ensure that threats have been addressed sufficiently. This should be done by writing up threat assessment for each method | ||
| - [ ] Assess potential risks of any new third party dependencies and decide whether a dependency audit is needed | ||
| - [ ] Completeness audit, fully implemented with tests (at least 1 person) (@assignee) | ||
| - [ ] Genesis import and export of all state | ||
| - [ ] Query services | ||
| - [ ] CLI methods | ||
| - [ ] All necessary migration scripts are present (if this is an upgrade of existing module) | ||
|
|
||
| ### Published Release Checklist | ||
|
|
||
| After the above checks have been audited and the module is included in a tagged Release Candidate, the following additional checklist should be undertaken for live testing, and potentially a 3rd party audit (if deemed necessary): | ||
|
|
||
| - [ ] Testnet / devnet testing (2-3 people) (@assignee1, @assignee2, @assignee3) | ||
| - [ ] All Msg methods have been tested especially in light of any potential threats identified | ||
| - [ ] Genesis import and export has been tested | ||
| - [ ] Nice to have (and needed in some cases if threats could be high): Official 3rd party audit |
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,87 @@ | ||
| <!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ | ||
| v ✰ Thanks for opening an issue! ✰ | ||
| v Before smashing the submit button please review the template. | ||
| v Word of caution: poorly thought-out proposals may be rejected | ||
| v without deliberation | ||
| ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> | ||
|
|
||
| ## Summary | ||
|
|
||
| <!-- In a few short sentences summarize the release --> | ||
|
|
||
| ## Major Changes | ||
|
|
||
| <!-- Describe the major changes associated to this release --> | ||
|
|
||
| ## Gotchas | ||
|
|
||
| <!-- Gotchas is an area which changes could of been made that the auditors should be aware of --> | ||
|
|
||
| ## QA Breakdown | ||
|
|
||
| * Audit | ||
| * [ ] Audit BaseApp | ||
| * [ ] Audit Types | ||
| * [ ] Audit x/auth | ||
| * [ ] Audit x/authz | ||
| * [ ] Audit x/bank | ||
| * [ ] Audit x/circuit | ||
| * [ ] Audit x/consensus | ||
| * [ ] Audit x/crisis | ||
| * [ ] Audit x/distribution | ||
| * [ ] Audit x/evidence | ||
| * [ ] Audit x/feegrant | ||
| * [ ] Audit x/genutil | ||
| * [ ] Audit x/gov | ||
| * [ ] Audit x/group | ||
| * [ ] Audit x/mint | ||
| * [ ] Audit x/nft | ||
| * [ ] Audit x/simulation | ||
| * [ ] Audit x/slashing | ||
| * [ ] Audit x/staking | ||
| * [ ] Audit x/tx | ||
| * [ ] Audit x/upgrade | ||
| * [ ] Audit client | ||
| * [ ] Audit server | ||
| * [ ] Audit store | ||
| * [ ] Audit runtime | ||
| * [ ] Audit simapp | ||
| * [ ] Release alpha | ||
| * [ ] Cosmos-SDK testnet | ||
| * [ ] Public testnet (IBC, WASM, SDK) | ||
| * [ ] Upgrade a chain with data from vX | ||
| * Release documentation | ||
| * [ ] Audit UPGRADING.md | ||
| * [ ] Update all codeblock to the appropriate version number | ||
|
|
||
|
|
||
| ### Audit checklist | ||
|
|
||
| * please copy to a markdown to follow while you walk through the code | ||
| * 2 people should be assigned to each section | ||
|
|
||
| * [ ] API audit | ||
| * spec audit: check if the spec is complete. | ||
| * Are Msg and Query methods and types well-named and organized? | ||
| * Is everything well documented (inline godoc as well as package [`README.md`](https://docs.cosmos.network/main/spec/SPEC_MODULE#common-layout) in module directory) | ||
| * check the proto definition - make sure everything is in accordance to ADR-30 (at least 1 person, TODO assignee) | ||
| * Check new fields and endpoints have the `Since: cosmos-sdk X` comment | ||
| * [ ] Completeness audit, fully implemented with tests | ||
| * [ ] Genesis import and export of all state | ||
| * [ ] Query services | ||
| * [ ] CLI methods | ||
| * [ ] All necessary migration scripts are present (if this is an upgrade of existing module) | ||
| * [ ] State machine audit | ||
| * [ ] Read through MsgServer code and verify correctness upon visual inspection | ||
| * [ ] Ensure all state machine code which could be confusing is properly commented | ||
| * [ ] Make sure state machine logic matches Msg method documentation | ||
| * [ ] Ensure that all state machine edge cases are covered with tests and that test coverage is sufficient (at least 90% coverage on module code) | ||
| * [ ] Assess potential threats for each method including spam attacks and ensure that threats have been addressed sufficiently. This should be done by writing up threat assessment for each method. Specifically we should be paying attention to: | ||
| * [ ] algorithmic complexity and places this could be exploited (ex. nested `for` loops) | ||
| * [ ] charging gas complex computation (ex. `for` loops) | ||
| * [ ] storage is safe (we don't pollute the state). | ||
| * [ ] Assess potential risks of any new third party dependencies and decide whether a dependency audit is needed | ||
| * [ ] Check correctness of simulation implementation if any | ||
| * [ ] Audit Changelog against commit log, ensuring all breaking changes, bug fixes, and improvements are properly documented. | ||
|
|
||
| If any changes are needed, please make them against main and backport them to release/vX.X.x |
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,50 @@ | ||
| <!-- | ||
| 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 | ||
| --> | ||
|
|
||
| ## 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 | ||
| * [ ] added `!` to the type prefix if API or client breaking change | ||
| * [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) | ||
| * [ ] provided a link to the relevant issue or specification | ||
| * [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules) | ||
| * [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/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 | ||
| * [ ] 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 `!` 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 | ||
| * [ ] manually tested (if applicable) |
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,38 @@ | ||
| ## Description | ||
|
|
||
| Closes: #XXXX | ||
|
|
||
| <!-- Add a description of the changes that this PR introduces and the files that | ||
| are the most critical to review. --> | ||
|
|
||
| <!-- Pull requests that sit inactive for longer than 30 days will be closed. --> | ||
| --- | ||
|
|
||
| ### 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/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) | ||
| - [ ] provided a link to the relevant issue or specification | ||
| - [ ] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/main/docs/DOC_WRITING_GUIDELINES.md) | ||
| - [ ] reviewed "Files changed" and left comments if necessary | ||
| - [ ] 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 thoroughness | ||
| - [ ] reviewed content for spelling and grammar | ||
| - [ ] tested instructions (if applicable) |
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/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) | ||
| - [ ] provided a link to the relevant issue or specification | ||
| - [ ] reviewed "Files changed" and left comments if necessary | ||
| - [ ] 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 |
Oops, something went wrong.