Contributing

Citry is what it is today because people like you jump in to help. Every bug report, fix, idea, and answered question makes the project better, and contributions of all sizes are welcome.

Found a bug?

Open an issue with the details of what went wrong.

The more details you can give, the faster it can be tracked down.

Got a fix?

Found a bug or a typo and know how to fix it? Open a pull request.

See what a good PR should include. We will help you get it across the finish line.

Have an idea?

Open a Discussions if you want to talk it through first
Open a feature request issue when you have a concrete proposal.

Describing the problem before the solution helps a lot.

Support the project

Citry is maintained in the open. Help it keep it going, sponsor the project on GitHub. Every bit helps.

Help others

You can help just by answering questions and sharing what you have worked out:

Discussions - questions, ideas, and general conversation.
Issues - bug reports and feature requests where an extra pair of eyes often unblocks someone.

Get coding

Citry is still young and there is a lot to build. Getting started is easy.

Find something to work on. Browse the open issues. Anything labeled good first issue is a friendly place to start.
Set up your environment.
Make your change, add or update tests, and run codebase checks
Open a pull request.

For the complete setup and workflow, see CONTRIBUTING.md.

For how the codebase fits together (the Rust crates, the language bindings, and how releases work), see docs/codebase.md.

Code of conduct

By taking part in the project you agree to uphold the Code of Conduct.