If you want to contribute to cynic, that's great! There's plenty of improvements to make, features that still need built and probably a bug or two hiding in there.
Please note we have a code of conduct, please follow it in all your interactions with the project.
There's a few different ways to contribute:
- If you've found a bug or have an idea for a feature you'd like to implement, please [create an issue][NewIssue] to discuss or send a message on discord.
- If you'd like to contribute to an existing issue feel free to comment on the issue and let us know. If anything isn't clear someone will be happy to explain (the project is still fairly new, and I have treated the issue tracker like a notepad occasionally, sorry about that 😬).
- If you'd like to contribute but you're not sure how:
- We have Good First Issues labelled.
- We use milestones to plan what's going into the next release, any free work in there would be great to pick up.
- The documentation (both on docs.rs & on cynic-rs.dev) could always be improved - try following one of the guides, and let us know what wasn't clear, what you thinks missing or even what
- You can just try to use cynic in a project - we'd appreciate any bug reports or feedback on the API, and it's always nice seeing what people build.
If you have any questions about how to do anything or otherwise need help, please just ask.
You can do this by:
cargo fmteverything- Don't use unsafe
- Don't leave warnings in the codebase.
- Ensure the build passes and your code meets the above guidelines.
- Ideally make sure you have some tests for any new functionality you've added.
- Update CHANGELOG.md with a new entry for your changes (under unreleased)
- Please write a reasonably detailed pull request message to help reviewer understand the context around & reason for the changes.
- A maintainer will review the PR as soon as possible, and once it is approved will merge and make a release.