You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-9
Original file line number
Diff line number
Diff line change
@@ -75,14 +75,13 @@ We welcome bug reports, feature requests, and other contributions to our project
75
75
76
76
3.**Provide detailed information**: In the issue description, clearly state the purpose of the issue and follow the guidelines of the issue template
77
77
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:
79
79
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.
86
85
87
86
## Pull Requests
88
87
@@ -256,7 +255,7 @@ Our release process is as follows:
256
255
2. Publish `ibc-derive` with `cargo publish -p ibc-derive`
257
256
4. Bump the versions of relevant crates (`ibc` and `ibc-query`) in their
258
257
`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.
260
259
5. Run `cargo doc -p ibc --all-features --open` locally to double-check that all the
261
260
documentation compiles and seems up-to-date and coherent. Fix any potential
262
261
issues here and push them to the release PR.
@@ -268,7 +267,7 @@ Our release process is as follows:
268
267
10. Create a signed tag and push it to GitHub: `git tag -s -a vX.Y.Z`. In the
269
268
tag message, write the version and the link to the corresponding section of
270
269
the changelog.
271
-
+ Push the tag with `git push --tags`
270
+
- Push the tag with `git push --tags`
272
271
11. Once the tag is pushed, create a GitHub release and append
0 commit comments