Skip to content

Commit 487c6df

Browse files
committed
doc: update CONTRIBUTING.md formatting and context guidelines
Signed-off-by: Yuki Kishimoto <[email protected]>
1 parent b08b9a5 commit 487c6df

File tree

1 file changed

+12
-30
lines changed

1 file changed

+12
-30
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Before writing code, please read [our code style](./CODE_STYLE.md).
66

77
To contribute a patch:
88

9-
* Fork Repository
10-
* Create topic branch
11-
* Commit patches (PR, emails, ...)
9+
- Fork Repository
10+
- Create topic branch
11+
- Commit patches (PR, emails, ...)
1212

1313
In general commits should be atomic and diffs **easy to read**.
1414

@@ -24,21 +24,18 @@ The commit **must** be formatted as following:
2424

2525
If applicable, link the `issue`/`PR` to be closed with:
2626

27-
* Closes <url>
28-
* Fixes <url>
27+
- Closes <url>
28+
- Fixes <url>
2929

3030
The `context` **must be**:
3131

32-
* `nostr` for changes to the `nostr` crate
33-
* `sdk`, `cli`, `pool`, `connect`, `nwc` and so on for the others crates (remote the `nostr-` prefix)
34-
* `ffi` for changes to `UniFFI` bindings
35-
* `js` for changes to `JavaScript` bindings
36-
* `test` for changes to the unit tests
37-
* `doc` for changes to the documentation
38-
* `contrib` for changes to the scripts and tools
39-
* `ci` for changes to the CI code
40-
* `refactor` for structural changes that do not change behavior
41-
* `book` if changes are related to the `book`
32+
- `nostr` for changes to the `nostr` crate
33+
- `sdk`, `cli`, `relay-pool`, `connect`, `nwc` and so on for the others crates (remote the `nostr-` prefix)
34+
- `test` for changes to the unit tests
35+
- `doc` for changes to the documentation
36+
- `contrib` for changes to the scripts and tools
37+
- `ci` for changes to the CI code
38+
- `refactor` for structural changes that do not change behavior
4239

4340
### Examples
4441

@@ -64,21 +61,6 @@ nwc: add `pay_multiple_invoices` support
6461
Closes https://<domain>.com/rust-nostr/nostr/issue/2222
6562
```
6663

67-
```
68-
ffi: expose `EventBuilder::mute_list`
69-
```
70-
71-
```
72-
ffi: add `AbortHandle`
73-
74-
- Return `AbortHandle` in `Client::handle_notifications`
75-
- Another change...
76-
```
77-
78-
```
79-
js: replace log `file path` with `module path`
80-
```
81-
8264
## Deprecation policy
8365

8466
Where possible, breaking existing APIs should be avoided.

0 commit comments

Comments
 (0)