diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a2430c3ec3..d30c905520 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -174,8 +174,8 @@ If a change does not alter any logic (e.g. comments, dependencies, docs), then i ### Labels -The set of labels and their description can be found [here](../docs/docs/repo/labels.md). -To change labels update [labels.yml](./labels.yml) file +The set of labels and their description can be found [labels.yml](/.github/labels.yml). +To change update this file and CI will automatically add/remove changed labels. ### Process diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8bbc88a043..ae811f02c8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,12 +2,12 @@ name: Bug report about: Create a report to help us improve title: '' -labels: 'Type: Bug' +labels: 'T-bug' assignees: '' --- -## Describe the bug +## Bug summary - @@ -96,5 +96,19 @@ specification section if a specification is not applicable): - operating system: - additional links: +## Acceptance criteria + +[] Bug was recreated in deterministic manner +[] Unit test that covers the problem +[] Regression test done +[] Bug is not reproducible anymore + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md new file mode 100644 index 0000000000..8ec6bff056 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -0,0 +1,30 @@ +--- +name: Epic +about: +title: 'collection of business/tech scope' +labels: 'Epic' +assignees: '' +--- +## Epic summary + +- + +## Links to related tech. design or research documents + +- + +## Sub issues + +- + +## Acceptance criteria + +[] Feature is complete and confirmed by Tech. lead and one more team member +[] Regression testing done + + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/general_report.md b/.github/ISSUE_TEMPLATE/general_report.md deleted file mode 100644 index 7b8fb12487..0000000000 --- a/.github/ISSUE_TEMPLATE/general_report.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: General issue -about: General purpose issue template -title: '' -assignees: '' - ---- - -## Issue summary - -- - - -## Other information and links - -- - - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/implementation.md b/.github/ISSUE_TEMPLATE/implementation.md new file mode 100644 index 0000000000..f90e7c1ece --- /dev/null +++ b/.github/ISSUE_TEMPLATE/implementation.md @@ -0,0 +1,34 @@ +--- +name: Implementation +about: General purpose issue template can be used pretty much for every implementation +title: 'Implement ... ' +labels: 'T-implementation' +assignees: '' + +--- + +## Issue summary + +- + +## Implementation details + +- + +## Other information and links + +- + +## Acceptance criteria + +[] Add AC's here.. +[] Regression testing (if applicable) +[] New code is 60% covered with unit tests + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/investigation_or_research.md b/.github/ISSUE_TEMPLATE/investigation_or_research.md new file mode 100644 index 0000000000..735fe2f0ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/investigation_or_research.md @@ -0,0 +1,26 @@ +--- +name: Investigation +about: +title: ' Investigate/ Research on ...' +labels: 'T-investigation' +assignees: '' +--- + +## Summary + + +## Related resources + + +## Acceptance criteria + +[] add open questions here.. +[] Summary, research paper or meta knowledge written and merged to main repo (if applicable) +[] Tech lead sign off +[] Team member sign off (mention who) +[] Workshop or knowledge session conducted if needed \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/software_design.md b/.github/ISSUE_TEMPLATE/software_design.md new file mode 100644 index 0000000000..a9814fb758 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/software_design.md @@ -0,0 +1,35 @@ +--- +name: Software Design +about: +title: 'Design ...' +labels: 'T-design' +assignees: '' +--- + +## Scope + + +## Functional Requirements + + +## Non-Functional Requirements + + + +## Related resources + + + +## Acceptance criteria + +[] Summary, design paper or meta knowledge written and merged to main repo +[] Artifacts produced +[] Tech lead sign off +[] Team member sign off (mention who) +[] Workshop or knowledge session conducted +[] Issues created and estimated (if necessary) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/task_report.md b/.github/ISSUE_TEMPLATE/task_report.md deleted file mode 100644 index 901c5c95e1..0000000000 --- a/.github/ISSUE_TEMPLATE/task_report.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Task requirement -about: Required tasks to complete -title: '' -assignees: '' - ---- - -## Task summary - -- - - -## Specification reference - -- - - - -## Other information and links - -- - - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/user_story.yml b/.github/ISSUE_TEMPLATE/user_story.yml deleted file mode 100644 index 9c23766d04..0000000000 --- a/.github/ISSUE_TEMPLATE/user_story.yml +++ /dev/null @@ -1,35 +0,0 @@ -name: User story -description: Create a user story -title: "User story: FILL-ME-PLEASE" -body: - - type: dropdown - id: role - attributes: - label: As a - options: - - Polkadot implementer (Default) - - Polkadot node operator - - Blockchain developer - - Dapp developer - - Authority node in a parachain - - Relay node in a relay chain - description: | - Describe the role you would play for this user story. - validations: - required: true - - type: textarea - id: wantto - attributes: - label: I want to - placeholder: "Develop this new feature and change this" - render: markdown - validations: - required: true - - type: textarea - id: because - attributes: - label: Because - placeholder: "Because I need to do something" - render: markdown - validations: - required: true diff --git a/.github/labels.yml b/.github/labels.yml index 20297907dd..0fc1e3d740 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -22,6 +22,11 @@ description: pull request with next release changes. # Action/attention needed label. Marks that there is a specific action needed for issue/PR +- name: A-in-QA-or-regression + color: "#8ceac8" + aliases: [] + description: pull request or issues is currently in QA or regression testing phase. + - name: A-tooBig color: "#FBCA04" aliases: [] @@ -47,46 +52,41 @@ aliases: [] description: issue requires detective debug work to figure out what's going wrong. -- name: A-design - color: "#FBCA04" - aliases: [] - description: issue requires design work to think about how it would best be accomplished. - # Describes the type of issue or pull request. - name: T-bug color: "#FEF2C0" aliases: [] description: this issue covers unexpected and/or wrong behaviour. -- name: T-feat +- name: T-implementation color: "#FEF2C0" aliases: [] description: this issue/pr is a new feature or functionality. -- name: T-enhancement +- name: T-research color: "#FEF2C0" aliases: [] - description: this issue/pr covers improvement of existing functionality. + description: this issue/pr is a research type issue. -- name: T-refactor +- name: T-investigation color: "#FEF2C0" aliases: [] - description: this issue/pr covers refactoring of existing code. + description: this issue/pr is an investigation, probably related to some bug with unknown causes. -- name: T-security +- name: T-design color: "#FEF2C0" - aliases: [] - description: this issue/pr covers security sensitive problem. + aliases: [ ] + description: this issue describes design requirements -- name: T-research +- name: T-refactor color: "#FEF2C0" aliases: [] - description: this issue/pr is a research type issue. + description: this issue/pr covers refactoring of existing code. -- name: T-investigation +- name: T-security color: "#FEF2C0" aliases: [] - description: this issue/pr is an investigation, probably related to some bug with unknown causes. + description: this issue/pr covers security sensitive problem. - name: T-question color: "#FEF2C0" diff --git a/docs/docs/repo/labels.md b/docs/docs/repo/labels.md index 757b965e64..81a71895c6 100644 --- a/docs/docs/repo/labels.md +++ b/docs/docs/repo/labels.md @@ -1,55 +1,3 @@ ## Labels -Below is the list of labels and their descriptions used in Gossamer repository. - - -- **Epic** - Issue used to track development status of a complex feature, aggregates several issues. -- **Feature-branch** - pull request from feature branch to origin. -- **Release** - pull request with next release changes. -- **good first issue** - issues that are suitable for first-time contributors. -- **`A-`** Action needed label. Marks that there is a specific action needed for issue/PR. - - **A-tooBig** - issue or PR needs to be broken down to smaller parts. - - **A-stale** - issue or PR is deprecated and needs to be closed. - - **A-blocked** - issue or PR is blocked until something else changes. - - **A-triage** - issue description needs refactor and/or labeled. - - **A-debug** - issue requires detective debug work to figure out what's going wrong. - - **A-design** - issue requires design work to think about how it would best be accomplished. -- **`T-`** Describes the type of issue or pull request. - - **T-bug** - this issue covers unexpected and/or wrong behaviour. - - **T-feat** - this issue/pr is a new feature or functionality. - - **T-enhancement** - this issue/pr covers improvement of existing functionality. - - **T-refactor** - this issue/pr covers refactoring of existing code. - - **T-security** - this issue/pr covers security sensitive problem. - - **T-research** - this issue/pr is a research type issue. - - **T-investigation** - this issue/pr is an investigation, probably related to some bug with unknown causes. -- **`C-`** Complexity label. We operate only 3 complexity levels. - - **C-simple** - Minor changes, no additional research needed. Good first issue/review. - - **C-complex** - Complex changes across multiple modules. Possibly will require additional research. - - **C-chaotic** - Unpredictable nature of this task/changes makes its chaotic. -- **`P-`** Priority level. We only have 3 priority levels, everything else is average by default. - - **P-critical** - this must be fixed immediately or contributors or users will be severely impacted. - - **P-high** - this should be addressed ASAP. **Colour #FBCA04** - - **P-low** - this is mostly nice to have. **Colour #0E8A16** -- **`S-`** Scope this work related to, could be multiple, but usually this means that task needs to be break down. - - **S-sync-[westend | kusama | polkadot | paseo]** - related to particular network syncing. - - **S-tests** - issue related to adding new tests. - - **S-doc** - documentation related. - - **S-cli** - issue related to Gossamer CLI. - - **S-ci** - issue related to continuous integration tasks or pipelines. - - **S-crypto** - issues related to the lib/crypto package. - - **S-grandpa** - issues related to block finality. - - **S-babe** - issues related to block production functionality. - - **S-runtime**- issues related to the lib/runtime package - - **S-telemetry** - issue related to node telemetry and metrics reports. - - **S-rpc** - issues related to the dot/rpc package. - - **S-scale** - issues related to the pkg/scale package. - - **S-utils** - issues related to all other lib packages. - - **S-network** - issues related to the dot/network package. - - **S-state** - issues related to dot/state package. - - **S-subsystems-overseer** - issues related to polkadot host overseer functionality. - - **S-subsystems-collator** - issues related to polkadot host collator subsystem functionality. - - **S-subsystems-backing** - issues related to polkadot host backing subsystem functionality. - - **S-subsystems-availability** - issues related to polkadot host availability subsystem functionality. - - **S-subsystems-disputes** - issues related to polkadot host disputes subsystem functionality. - - **S-infrastructure** - issues related to infrastructure and DevOps. - - **S-dependencies** - issues related to dependencies changes. Used by dependabot. +Please refer to the list of [labels.yml](/.github/labels.yml) \ No newline at end of file