Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (40 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.37 KB

Contributing

Organization guidelines

This project follows the rust-nostr organization guidelines: https://github.com/rust-nostr/guidelines

Additional repository guidelines

Commit Style

The commit must be formatted as follows:

<context>: <short description>

<description explaining reasons for the changes>

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

  • Closes
  • Fixes

The context must be:

  • nostr for changes to the nostr crate
  • sdk, cli, relay-pool, connect, nwc and so on for the others crates (remove the nostr- prefix)
  • test for changes to the unit tests
  • doc for changes to the documentation
  • contrib for changes to the scripts and tools
  • ci for changes to the CI code
  • refactor for structural changes that do not change behavior

Examples

nostr: add NIP32 support

Added kinds, tags and EventBuilder constructors to support NIP32.

Closes https://<domain>.com/rust-nostr/nostr/issue/1234

pool: fix connection issues

Long description...

Fixes https://<domain>.com/rust-nostr/nostr/issue/5612

nwc: add `pay_multiple_invoices` support

Closes https://<domain>.com/rust-nostr/nostr/issue/2222

Coding Conventions

Install https://github.com/casey/just and use just precommit or just ci to format and check the code before committing. The CI also enforces this.