@@ -6,9 +6,9 @@ Before writing code, please read [our code style](./CODE_STYLE.md).
6
6
7
7
To contribute a patch:
8
8
9
- * Fork Repository
10
- * Create topic branch
11
- * Commit patches (PR, emails, ...)
9
+ - Fork Repository
10
+ - Create topic branch
11
+ - Commit patches (PR, emails, ...)
12
12
13
13
In general commits should be atomic and diffs ** easy to read** .
14
14
@@ -24,21 +24,18 @@ The commit **must** be formatted as following:
24
24
25
25
If applicable, link the ` issue ` /` PR ` to be closed with:
26
26
27
- * Closes <url >
28
- * Fixes <url >
27
+ - Closes <url >
28
+ - Fixes <url >
29
29
30
30
The ` context ` ** must be** :
31
31
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
42
39
43
40
### Examples
44
41
@@ -64,21 +61,6 @@ nwc: add `pay_multiple_invoices` support
64
61
Closes https://<domain>.com/rust-nostr/nostr/issue/2222
65
62
```
66
63
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
-
82
64
## Deprecation policy
83
65
84
66
Where possible, breaking existing APIs should be avoided.
0 commit comments