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

Commit e94cb0d

Browse files
authored
Improve contribution guidelines (#13902)
1 parent 16b2e64 commit e94cb0d

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/CONTRIBUTING.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,11 @@ A Pull Request (PR) needs to be reviewed and approved by project maintainers unl
3636
*Process:*
3737

3838
. Please tag each PR with exactly one `A`, `B`, `C` and `D` label at the minimum.
39+
. When tagging a PR, it should be done while keeping all downstream users in mind. Downstream users are not just Polkadot or system parachains, but also all the other parachains and solo chains that are using Substrate. The labels are used by downstream users to track changes and to include these changes properly into their own releases.
3940
. Once a PR is ready for review please add the https://github.com/paritytech/substrate/pulls?q=is%3Apr+is%3Aopen+label%3AA0-please_review+[`A0-please_review`] label. Generally PRs should sit with this label for 48 hours in order to garner feedback. It may be merged before if all relevant parties had a look at it.
4041
. If the first review is not an approval, swap `A0-please_review` to any label `[A3, A5]` to indicate that the PR has received some feedback, but needs further work. For example. https://github.com/paritytech/substrate/labels/A3-in_progress[`A3-in_progress`] is a general indicator that the PR is work in progress.
41-
. PRs must be tagged with their release notes requirements via the `B*` labels. If a PR should be mentioned in the release notes, use `B1` and add either: `T0-node`, `T1-runtime`or `T2-API` - this defines in which section of the release notes the PR will be shown.
42-
. PRs must be tagged with their release importance via the `C1-C7` labels.
42+
. PRs must be tagged with `B*` labels to signal if a change is note worthy for downstream users. The respective `T*` labels should be added to signal the component that was changed. `B0-silent` must only be used for changes that don't require any attention by downstream users.
43+
. PRs must be tagged with their release importance via the `C1-C7` labels. The release importance is only informing about how important it is to apply a release that contains the change.
4344
. PRs must be tagged with their audit requirements via the `D1-D9` labels.
4445
. PRs that introduce runtime migrations must be tagged with https://github.com/paritytech/substrate/labels/E0-runtime_migration[`E0-runtime_migration`]. See the https://github.com/paritytech/substrate/blob/master/utils/frame/try-runtime/cli/src/lib.rs#L18[Migration Best Practices here] for more info about how to test runtime migrations.
4546
. PRs that introduce irreversible database migrations must be tagged with https://github.com/paritytech/substrate/labels/E1-database_migration[`E1-database_migration`].
@@ -50,7 +51,13 @@ A Pull Request (PR) needs to be reviewed and approved by project maintainers unl
5051
. PRs should be categorized into projects.
5152
. No PR should be merged until all reviews' comments are addressed and CI is successful.
5253

53-
*Reviewing pull requests*:
54+
*Noting relevant changes:*
55+
56+
When breaking APIs, it should be mentioned on what was changed in the PR description alongside some examples on how to change the code to make it work/compile.
57+
58+
The PR description should also mention potential storage migrations and if they require some special setup aside adding it to the list of migrations in the runtime.
59+
60+
*Reviewing pull requests:*
5461

5562
When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:
5663

0 commit comments

Comments
 (0)