Contribute

This project is distributed under the Apache 2.0 license.

Note

nepenthe requires Developer Certificate of Origin for all contributions. This is enforced by a Probot GitHub App, which checks that commits are "signed". Read instructions to configure commit signing.

Open an issue on our issues page for bug reports and small feature requests.

Use our discussions page for questions and larger changes or features.

For contributions, please see our developer documentation. We have help wanted and good first issue tags on our issues page, so those are a good place to start. The Architecture page explains how nepenthe is built: the crate layout, module boundaries, and design decisions.

For documentation updates, make PRs that update the pages in /docs/wiki. The documentation is pushed to the GitHub wiki automatically through a GitHub workflow. Note that direct updates to this wiki will be overwritten.