Skip to content

Commit

Permalink
doc: small adj. to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Yuki Kishimoto <[email protected]>
  • Loading branch information
yukibtc committed Dec 4, 2024
1 parent 397fe20 commit 80f973c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to the Rust Nostr SDK
# Contributing to rust-nostr

## Contribution Workflow

Expand Down Expand Up @@ -30,8 +30,8 @@ If applicable, link the `issue`/`PR` to be closed with:
The `context` should be:

* `nostr` if changes are related to the main Rust `nostr` crate (or `protocol`?)
* `sdk`, `cli`, `pool`, `signer`, `nwc` and so on for the others Rust crates (so basically remove the `nostr-` prefix)
* `ffi(<name>)` for `UniFFI` and `js(<name>)` for `JavaScript` bindings (follow same above rules for the `<name>`)
* `sdk`, `cli`, `pool`, `signer`, `nwc` and so on for the others Rust crates (so remove the `nostr-` prefix)
* `ffi` for `UniFFI`, `js` for `JavaScript` bindings and so on
* `book` if changes are related to the `book`
* `doc` for the `.md` files (except for `CHANGELOG.md`?)

Expand Down Expand Up @@ -63,18 +63,18 @@ Closes https://<domain>.com/rust-nostr/nostr/issue/2222
```

```
ffi(nostr): add `EventBuilder::mute_list`
ffi: expose `EventBuilder::mute_list`
```

```
ffi(sdk): add `AbortHandle`
ffi: add `AbortHandle`
* Return `AbortHandle` in `Client::handle_notifications`
* Another change...
```

```
js(sdk): replace log `file path` with `module path`
js: replace log `file path` with `module path`
```

## Deprecation policy
Expand All @@ -98,4 +98,4 @@ Usage of `.unwrap()` or `.expect("...")` methods is allowed **only** in `example

Install https://github.com/casey/just and use `just precommit` or `just check`
to format and check the code before committing.
This is also enforced by the CI.
This is also enforced by the CI.

0 comments on commit 80f973c

Please sign in to comment.