Contributing

You want to help Citry. Bug reports, fixes, ideas, and answered questions all make the project better, and help of any size is welcome. Pick the section that matches what you want to do.

Report a bug

Open an issue that describes what went wrong. The more detail you give, the faster someone can track it down. Getting help lists what to include.

Send a fix

Found a bug or a typo and know how to fix it? Open a pull request. Make a change lists what a good pull request includes, and we will help you get it merged.

Suggest an idea

• To talk an idea through first, start a discussion.
• When you have a concrete proposal, open a feature request.

Describe the problem before the solution. It helps a lot.

Answer questions

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

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

Write code

Citry is still young and there is a lot to build.

1. Find something to work on in the open issues. Issues labeled good first issue are a friendly place to start.
2. Set up your machine.
3. Make your change, add or update tests, and run the checks.
4. Open a pull request.

A short version of this setup is in CONTRIBUTING.md in the repository. For how the codebase fits together (the Rust crates, the language bindings, and how releases work), see docs/codebase.md.

Sponsor the project

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

Code of conduct

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