Flux is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on to make it easier to get your contribution accepted.
We gratefully welcome improvements to issues and documentation as well as to code.
By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.
We require all commits to be signed. By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the DCO:
Signed-off-by: Jane Doe <[email protected]>
The signature must contain your real name
(sorry, no pseudonyms or anonymous contributions)
If your user.name and user.email are configured in your Git config,
you can sign your commit automatically with git commit -s.
For this repository we prefer the following rules for good commit messages:
- Limit the subject to 50 characters and write as the continuation of the sentence "If applied, this commit will ..."
- Explain what and why in the body, if more than a trivial change; wrap it at 72 characters.
The following article has some more helpful advice on documenting your work.
For realtime communications we use Slack: To join the conversation, simply join the CNCF Slack workspace and use the #flux-dev channel.
To discuss ideas and specifications we use Github Discussions.
For announcements we use a mailing list as well. Simply subscribe to flux-dev on cncf.io to join the conversation (there you can also add calendar invites to your Google calendar for our Flux meeting).