You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- PRs: link the motivating issue, include `cargo test` output, and call out schema or config changes to ease verification.
39
+
-**Protocol/tag changes:** prefer single-kind (single event domain) PRs. Cross-kind changes require a scope declaration and compatibility statement in the PR body (see `CONTRIBUTING.md § Protocol / Tag Changes`).
39
40
40
41
## Documentation Guidelines
41
42
- Do not hardcode source code line numbers in documentation (e.g., `src/app/take_buy.rs:11`). Line numbers drift as the codebase evolves, misleading developers. Reference file paths (`src/app/take_buy.rs`) or function names (`fn take_buy_action`) instead, which are far more stable and easily searchable.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,24 @@ All Mostro contributors submit changes via pull requests. The workflow is as fol
21
21
22
22
Pull requests should be focused on a single change. Do not mix, for example, refactorings with a bug fix or implementation of a new feature. This practice makes it easier for fellow contributors to review each pull request.
23
23
24
+
### Protocol / Tag Changes
25
+
26
+
Changes that affect Nostr event tags (e.g. `y` tags, `z` tags) or event kinds are **protocol changes** and deserve extra care:
27
+
28
+
-**Single-kind PRs preferred** – limit each PR to one event domain (orders, info, dispute, admin, dev-fee) whenever possible.
29
+
-**Cross-kind changes** – if a PR must touch multiple event domains, include a "Scope Declaration" section in the PR body (see template below) and explain why the change cannot be split.
30
+
-**Compatibility statement** – every protocol-tag PR must state the impact on external consumers (indexers, clients, relays).
Mostro follows the review workflow established by the Bitcoin Core project. The following is adapted from the [Bitcoin Core contributor documentation](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#peer-review):
@@ -33,6 +51,8 @@ Anyone may participate in peer review which is expressed by comments in the pull
33
51
-`Concept ACK` means "I agree in the general principle of this pull request";
34
52
-`Nit` refers to trivial, often non-blocking issues.
35
53
54
+
Reviewers should also verify **external contract impact** for any PR that modifies event kinds, tags, or message formats — confirm that indexers, clients, and relays are not silently broken by the change.
55
+
36
56
Please note that Pull Requests marked `NACK` and/or GitHub's `Change requested` are closed after 30 days if not addressed.
0 commit comments