1.3 KiB
Juniper Contribution Guide
Juniper is always looking for new contributors, so don't be afraid to jump in and help!
The maintainers are happy to provide guidance if required.
To get started, you can look for issues with the "help wanted" label.
PR Checklist
Before submitting a PR, you should follow these steps to prevent redundant churn or CI failures:
[ ] Ensure proper formatting [ ] Run all tests [ ] Update the CHANGELOG
Ensure proper formatting
Consistent formatting is enforced on the CI.
Before you submit your PR, you should run cargo fmt in the root directory.
Formatting should be run on the stable compiler.
(You can do rustup run stable cargo fmt when developing on nightly)
Run all tests
To run all available tests, including verifying the code examples in the book, you can use cargo-make.
- Install cargo-make with
cargo install cargo-make - Run
cargo make ci-flowin the root directory
Update the CHANGELOG
Add your changes to the relevant changelog if they affect users in any way. Each sub-crate has it's own CHANGELOG.md.
Your changes should be added to a [master] section on top of the file.