Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Commit 6b54fdf

Browse files
Description for new cumulus labels (#1879)
* Add files via upload Documentation for new labels * Update documentation.md
1 parent 16c944a commit 6b54fdf

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

docs/documentation.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
2+
3+
This is the documentation for the repo `paritytech/cumulus`.
4+
5+
It contains 65 labels:
6+
7+
### A Labels: Action labels, used with GHA and trigger a certain process
8+
- `A0-please_review`: *Pull request needs code review.*
9+
- `A1-needs_burnin`: *Pull request needs to be tested on a live validator node before merge. DevOps is notified via matrix*
10+
- `A2-insubstantial`: *Pull request requires no code review (e.g., a sub-repository hash update).*
11+
- `A3-in_progress`: *Pull request is in progress. No review needed at this stage.*
12+
- `A4-companion`: *A PR that should be considered alongside another (usually more comprehensive and detailed) PR.*
13+
- `A5-stale`: *Pull request did not receive any updates in a long time. No review needed at this stage. Close it.*
14+
- `A6-backport`: *Pull request is already reviewed well in another branch.*
15+
16+
### B labels: Release note labels, to be used in combination with a T* label
17+
- `B0-silent`: *Changes should not be mentioned in any release notes*
18+
- `B1-note_worthy`: *Changes should be noted in the release notes*
19+
20+
### C labels: Criticality - how critical is this change? Which impact does it have on the builders? To be used in combination with a T* label
21+
- `C1-low`: *PR touches the given topic and has a low impact on builders.*
22+
- `C3-medium`: *PR touches the given topic and has a medium impact on builders.*
23+
- `C5-high`: *PR touches the given topic and has a high impact on builders.*
24+
- `C7-critical`: *PR touches the given topic and has a critical impact on builders.*
25+
26+
### D labels: Auditing labels, optional for cumulus
27+
- `D1-audited 👍`: *PR contains changes to fund-managing logic that has been properly reviewed and externally audited.*
28+
- `D2-notlive 💤`: *PR contains changes in a runtime directory that is not deployed to a chain that requires an audit.*
29+
- `D3-trivial 🧸`: *PR contains trivial changes in a runtime directory that do not require an audit*
30+
- `D5-nicetohaveaudit ⚠️`: *PR contains trivial changes to logic that should be properly reviewed.*
31+
- `D9-needsaudit 👮`: *PR contains changes to fund-managing logic that should be properly reviewed and externally audited*
32+
33+
### E labels: Upgrade dependencies
34+
- `E0-runtime_migration`: *PR introduces code that might require downstream chains to run a runtime upgrade.*
35+
- `E1-database_migration`: *PR introduces code that does a one-way migration of the database.*
36+
- `E2-dependencies`: *Pull requests that update a dependency file.*
37+
- `E3-host_functions`: *PR adds new host functions which requires a node release before a runtime upgrade.*
38+
- `E4-node_first_update`: *This is a runtime change that will require all nodes to be update BEFORE the runtime upgrade.*
39+
40+
### F labels: Fail - change breaks some part of the code
41+
- `F0-breaks_everything`: *This change breaks the underlying networking, sync or related and thus will cause a fork.*
42+
- `F1-breaks_authoring`: *This change breaks authorities or authoring code.*
43+
- `F2-breaks_consensus`: *This change breaks consensus or consensus code.*
44+
- `F3-breaks_API`: *This PR changes public API; next release should be major.*
45+
46+
### I labels: Issue related labels
47+
- `I0-consensus`: *Issue can lead to a consensus failure.*
48+
- `I1-panic`: *The node panics and exits without proper error handling.*
49+
- `I2-security`: *The node fails to follow expected, security-sensitive, behaviour.*
50+
- `I3-bug`: *The node fails to follow expected behavior.*
51+
- `I4-annoyance`: *The node behaves within expectations, however this “expected behaviour” itself is at issue.*
52+
- `I5-tests`: *Tests need fixing, improving or augmenting.*
53+
- `I6-documentation`: *Documentation needs fixing, improving or augmenting.*
54+
- `I7-refactor`: *Code needs refactoring.*
55+
- `I8-footprint`: *An enhancement to provide a smaller (system load, memory, network or disk) footprint.*
56+
- `I9-optimisation`: *An enhancement to provide better overall performance in terms of time-to-completion for a task.*
57+
58+
### J labels: Just a continuation of the issue related labels
59+
- `J0-enhancement`: *An additional feature request.*
60+
- `J1-meta`: *A specific issue for grouping tasks or bugs of a specific category.*
61+
- `J2-unconfirmed`: *Issue might be valid, but it's not yet known.*
62+
- `J3-intended`: *Issue describes a behavior which turns out to work as intended. Closer should explain why.*
63+
- `J4-duplicate`: *Issue is a duplicate. Closer should comment with a link to the duplicate.*
64+
- `J5-wont_fix`: *Issue is in principle valid, but this project will not address it. Closer should explain why.*
65+
- `J6-invalid`: *Issue is invalid. Closer should comment why.*
66+
67+
### S labels: Status of an issue
68+
- `S0-design`: *Issue is in the design stage.*
69+
- `S1-implement`: *Issue is in the implementation stage.*
70+
- `S2-test/monitor`: *Issue is in the testing stage.*
71+
- `S3-deploy`: *Issue is in the deployment stage*
72+
- `S4-blocked`: *Issue is blocked, see comments for further information.*
73+
74+
### T labels: Topics - to be used in combination with other labels
75+
- `T0-node`: *This PR/Issue is related to the topic “node”.*
76+
- `T1-runtime`: *This PR/Issue is related to the topic “runtime”.*
77+
- `T10-release`: *This PR/Issue is related to topics touching the release notes.*
78+
- `T2-API`: *This PR/Issue is related to APIs.*
79+
- `T3-relay_chain`: *This PR/Issue is related to the relay chain.*
80+
- `T4-smart_contracts`: *This PR/Issue is related to smart contracts.*
81+
- `T5-parachains`: *This PR/Issue is related to Parachains.*
82+
- `T6-XCM`: *This PR/Issue is related to XCM.*
83+
- `T7-statemint`: *This PR/Issue is related to Statemint*
84+
- `T7-substrate`: *This is an issue that needs to be implemented upstream in Substrate.*
85+
- `T8-CGP`: *This PR/Issue is related to Common Good Parachains.*
86+
87+
### U labels: Urgency - in what time manner does this issue need to be resolved?
88+
- `U0-drop_everything`: *Everyone should address the issue now.*
89+
- `U1-asap`: *No need to stop dead in your tracks, however issue should be addressed as soon as possible.*
90+
- `U2-some_time_soon`: *Issue is worth doing soon.*
91+
- `U3-nice_to_have`: *Issue is worth doing eventually.*
92+
- `U4-some_day_maybe`: *Issue might be worth doing eventually.*

0 commit comments

Comments
 (0)