Skip to content

Commit 0cf8e0f

Browse files
committed
doc: point to organization guidelines
Signed-off-by: Yuki Kishimoto <[email protected]>
1 parent 3e8a80d commit 0cf8e0f

File tree

3 files changed

+9
-335
lines changed

3 files changed

+9
-335
lines changed

CODE_STYLE.md

Lines changed: 0 additions & 279 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
# Contributing to rust-nostr
1+
# Contributing
22

3-
## Contribution Workflow
3+
## Organization guidelines
44

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
66

7-
To contribute a patch:
7+
## Additional repository guidelines
88

9-
- Fork Repository
10-
- Create topic branch
11-
- Commit patches (PR, emails, ...)
9+
### Commit Style
1210

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:
1812

1913
```
2014
<context>: <short descriptrion>
@@ -61,35 +55,8 @@ nwc: add `pay_multiple_invoices` support
6155
Closes https://<domain>.com/rust-nostr/nostr/issue/2222
6256
```
6357

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
8059

8160
Install https://github.com/casey/just and use `just precommit` or `just check`
8261
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.

SECURITY.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
11
# Reporting a Vulnerability
22

3-
To report security issues send an email to **[email protected]**
4-
5-
The following keys may be used to communicate sensitive information to developers:
6-
7-
| Name | Fingerprint |
8-
| ------------------- | -------------------------------------------------------------------------------------------------------------------------- |
9-
| Yuki Kishimoto | 86F3 105A DFA8 AB58 7268 DCD7 8D3D CD04 2496 19D1 |
10-
11-
You can import a key by running the following command with that individual’s fingerprint:
12-
13-
```
14-
gpg --keyserver hkps://keys.openpgp.org --recv-keys "<fingerprint>"
15-
```
16-
17-
Ensure that you put quotes around fingerprints containing spaces.
3+
For security vulnerability reporting and our complete security policy, please see: https://github.com/rust-nostr/guidelines

0 commit comments

Comments
 (0)