|
1 |
| -# Contributing to rust-nostr |
| 1 | +# Contributing |
2 | 2 |
|
3 |
| -## Contribution Workflow |
| 3 | +## Organization guidelines |
4 | 4 |
|
5 |
| -Before writing code, please read [our code style](./CODE_STYLE.md). |
| 5 | +This project follows the rust-nostr organization guidelines: https://github.com/rust-nostr/guidelines |
6 | 6 |
|
7 |
| -To contribute a patch: |
| 7 | +## Additional repository guidelines |
8 | 8 |
|
9 |
| -- Fork Repository |
10 |
| -- Create topic branch |
11 |
| -- Commit patches (PR, emails, ...) |
| 9 | +### Commit Style |
12 | 10 |
|
13 |
| -In general commits should be atomic and diffs **easy to read**. |
14 |
| - |
15 |
| -## Commit Style |
16 |
| - |
17 |
| -The commit **must** be formatted as following: |
| 11 | +The commit **must** be formatted as follows: |
18 | 12 |
|
19 | 13 | ```
|
20 | 14 | <context>: <short descriptrion>
|
@@ -61,35 +55,8 @@ nwc: add `pay_multiple_invoices` support
|
61 | 55 | Closes https://<domain>.com/rust-nostr/nostr/issue/2222
|
62 | 56 | ```
|
63 | 57 |
|
64 |
| -## Deprecation policy |
65 |
| - |
66 |
| -Where possible, breaking existing APIs should be avoided. |
67 |
| -Instead, add new APIs and use |
68 |
| -[`#[deprecated]`](https://github.com/rust-lang/rfcs/blob/master/text/1270-deprecation.md) |
69 |
| -to discourage use of the old one. |
70 |
| - |
71 |
| -Deprecated APIs are typically maintained for one release cycle. |
72 |
| -In other words, an API that has been deprecated with the 0.10 release |
73 |
| -can be expected to be removed in the 0.11 release. |
74 |
| -This allows for smoother upgrades without incurring too much technical debt inside this library. |
75 |
| - |
76 |
| -If you deprecated an API as part of a contribution, we encourage you to "own" that API |
77 |
| -and send a follow-up to remove it as part of the next release cycle. |
78 |
| - |
79 |
| -## Coding Conventions |
| 58 | +### Coding Conventions |
80 | 59 |
|
81 | 60 | Install https://github.com/casey/just and use `just precommit` or `just check`
|
82 | 61 | to format and check the code before committing.
|
83 |
| -This is also enforced by the CI. |
84 |
| - |
85 |
| -### Terminology |
86 |
| - |
87 |
| -Concept ACK - Agree with the idea and overall direction, but haven't reviewed the code changes or tested them. |
88 |
| - |
89 |
| -utACK (untested ACK) - Reviewed and agree with the code changes but haven't actually tested them. |
90 |
| - |
91 |
| -tACK (tested ACK) - Reviewed the code changes and have verified the functionality or bug fix. |
92 |
| - |
93 |
| -ACK - A loose ACK can be confusing. It's best to avoid them unless it's a documentation/comment only change in which case there is nothing to test/verify; therefore the tested/untested distinction is not there. |
94 |
| - |
95 |
| -NACK - Disagree with the code changes/concept. Should be accompanied by an explanation. |
| 62 | +The CI also enforces this. |
0 commit comments