We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.
Participation in this project comes under the Contributor Covenant Code of Conduct
- We follow the GitHub Pull Request Model for all contributions.
- For large bodies of work, we recommend creating an issue and labelling it "kind/design" outlining the feature that you wish to build, and describing how it will be implemented. This gives a chance for review to happen early, and ensures no wasted effort occurs.
- For new features, documentation must be included. Documentation can currently be found under the docs folder.
- All submissions, including submissions by project members, will require review before being merged.
- Finally - Thanks for considering submitting code to Quilkin!
See our Quilkin Development and Building Guide for developing, testing and building Quilkin.
When submitting pull requests, make sure to do the following:
- Format all Rust code with rustfmt.
- Ensure all Rust code passes the Rust clippy linter.
- Remove trailing whitespace. Many editors will do this automatically.
- Ensure any new files have a trailing newline
Continuous integration is provided by Google Cloud Build, through the cloudbuild.yaml file found at the root of the directory, and integrated with the Github repository via the Cloud Build Github app.
Build success or failure are displayed on each pull request with relevant details.
To gain access to the details of a specific Cloud Build, join the quilkin-discuss google group.
See the Google Cloud Build documentation for more details on how to edit and expand the build process.
- At the monthly community meeting it will be decided if a release should be built.
- To release, create an issue from the release issue template, tag it as
kind/releaseand follow each of the steps.
- How to write a good Git Commit message - Great way to make sure your Pull Requests get accepted.