Portefaix 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 <jane.doe@example.com>
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.
To discuss ideas and specifications we use Github Discussions.
This project is composed of:
- portefaix: The Terraform and Kubernetes code
- portefaix-hub: Helm charts repository for Portefaix
These things will make a PR more likely to be accepted:
- a well-described requirement
- a good commit message (see below)