Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Maintainers. Last matching pattern takes precedence.
* @benalleng @DanGould @spacebear21
46 changes: 46 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,31 @@ Most discussion about Payjoin research and development happens on [Discord](http

---

## Scope

Issues and pull requests are for technical substance. Foundation
governance, personnel, and licensing or IP matters are out of scope. Take
them to [Foundation leadership](https://payjoin.org/blog/2025/08/08/announcing-payjoin-foundation/)
directly at [admin@payjoin.org](mailto:admin@payjoin.org). Maintainers may lock or hide
off-topic threads by pointing to this section, and may temporarily block
accounts for sustained off-topic participation, with notice.

---

## Issues

Using and testing Payjoin Dev Kit is an effective way for new contributors to both learn and provide value. If you find a bug, incorrect or unclear documentation, or have any other problem, consider [creating an issue](https://github.com/payjoin/rust-payjoin/issues). Before doing so, please search through [existing issues](https://github.com/payjoin/rust-payjoin/issues) to see if your problem has already been addressed or is actively being discussed. If you can, provide a fully reproducible example or the steps we can use to reproduce the issue to speed up the debugging process.

---

## Security

Do not open public issues or pull requests for vulnerabilities. Report them
privately to [security@payjoin.org](mailto:security@payjoin.org) as described
in [SECURITY.md](SECURITY.md).

---

## Documentation

Good documentation is essential to understanding what PDK does and how to use it. Since PDK seeks to raise Payjoin adoption by making it easy for developers to integrate it into their wallets, providing clear and complete documentation is critical. Good documentation is also invaluable to new contributors ramping up quickly. If _you_ find something hard to understand or difficult to figure out how to use from the documentation, it's a sign they could be improved. To contribute to the documentation please [fork the repository](https://github.com/payjoin/rust-payjoin/fork), make changes there, and then submit a pull request.
Expand Down Expand Up @@ -152,3 +171,30 @@ nix fmt
### Linting

We use [`clippy`](https://github.com/rust-lang/rust-clippy) for linting. Please run `contrib/lint.sh` using the nightly toolchain before submitting any changes.

---

## Review and Merging

Pull requests are reviewed on technical merit by the repository
maintainers listed in [CODEOWNERS](CODEOWNERS). Protocol wire behavior
follows the BIP process
([BIP 78](https://github.com/bitcoin/bips/blob/master/bip-0078.mediawiki),
[BIP 77](https://github.com/bitcoin/bips/blob/master/bip-0077.md)).
Observable behavior not yet pinned down by a BIP may merge, but is not
considered production ready until it is publicly specified. When
maintainers proceed over a significant technical objection, the rationale
is written up publicly.

---

## Licensing

Crates in this workspace are licensed as declared in each crate's
`Cargo.toml`: `MITNFA` for most crates, dual MIT/Apache-2.0 for
`payjoin-ffi`. Relicensing the workspace to dual MIT/Apache-2.0 is in
progress in [#1540](https://github.com/payjoin/rust-payjoin/issues/1540).
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be licensed under the license of the crate it modifies and
dual MIT/Apache-2.0, without any additional terms or conditions.
8 changes: 8 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Security Policy

To report a vulnerability, email
[security@payjoin.org](mailto:security@payjoin.org). Do not open a public
issue or pull request for anything security-sensitive.

We follow coordinated disclosure: we will work with you on a fix and agree
on a disclosure timeline before details are published.
Loading