Skip to content

Commit 26c7ba6

Browse files
chore: simplify GitHub issue labeling (#925)
1 parent 245d2fc commit 26c7ba6

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

CONTRIBUTING.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,13 @@ We welcome bug reports, feature requests, and other contributions to our project
7575

7676
3. **Provide detailed information**: In the issue description, clearly state the purpose of the issue and follow the guidelines of the issue template
7777

78-
4. A maintainer will take care of assigning the appropriate labels to your issue.
78+
Note: A maintainer will take care of assigning the appropriate labels to your issue with the following convention:
7979

80-
We use the following convention for issue label names:
81-
- (WHY) The purpose or objective of this issue with Objective-level "O" labels like `O: security`, `O: new-feature`, etc.
82-
- (WHICH) The part of the system this issue relates to using:
83-
- External-level "E" labels if the issue fall outside the current scope of the system and is related to external dependencies or projects like `E: non-cosmos`, `E: no-std` etc.
84-
- or "Internal-level "I" labels for anything related to the current scope of the product like `I: errors`, `I: documentation`, etc.
85-
- (HOW) If any administrative considerations should be taken into account use Administrative-level "A" labels like `A: help-wanted`, `A: critical`, etc.
80+
- Objective-level (WHY): conveys the overarching purpose or objective of the issue by labels starting with "O" like `O: security`, `O: new-feature`, etc.
81+
82+
- Scope-level (WHICH): specifies the part of the system that the issue pertains to and labels starting with "S" like `S: non-cosmos`, `S: no-std`, etc.
83+
84+
- Admin-level (HOW) includes relevant administrative considerations on how best handling the issue and labels starting with "A" like `A: help-wanted`, `A: critical`, etc.
8685

8786
## Pull Requests
8887

@@ -256,7 +255,7 @@ Our release process is as follows:
256255
2. Publish `ibc-derive` with `cargo publish -p ibc-derive`
257256
4. Bump the versions of relevant crates (`ibc` and `ibc-query`) in their
258257
`Cargo.toml` to the new version, and push these changes to the release PR.
259-
+ If you released a new version of `ibc-derive` in step 3, make sure to update that dependency.
258+
- If you released a new version of `ibc-derive` in step 3, make sure to update that dependency.
260259
5. Run `cargo doc -p ibc --all-features --open` locally to double-check that all the
261260
documentation compiles and seems up-to-date and coherent. Fix any potential
262261
issues here and push them to the release PR.
@@ -268,7 +267,7 @@ Our release process is as follows:
268267
10. Create a signed tag and push it to GitHub: `git tag -s -a vX.Y.Z`. In the
269268
tag message, write the version and the link to the corresponding section of
270269
the changelog.
271-
+ Push the tag with `git push --tags`
270+
- Push the tag with `git push --tags`
272271
11. Once the tag is pushed, create a GitHub release and append
273272
`[📖CHANGELOG](https://github.com/cosmos/ibc-rs/blob/main/CHANGELOG.md#vXYZ)`
274273
to the release description.

0 commit comments

Comments
 (0)