How to Contribute
We’d love to accept your patches and contributions to this project. Please review the following guidelines you’ll need to follow in order to make a contribution.
We prefer communicating asynchronously through GitHub issues and the #carvel Slack channel. In order to be inclusive to the community, if a conversation related to an issue happens outside of these channels, we appreciate summarizing the conversation’s context and adding it to an issue.
Propose a Change ¶
Pull requests are welcome for all changes. When adding new functionality, we encourage including test coverage. If significant effort will be involved, we suggest beginning by submitting an issue so any high level feedback can be addressed early.
Please submit feature requests and bug reports by using GitHub issues.
Before submitting an issue, please search through open ones to ensure others have not submitted something similar. If a similar issue exists, please add any additional information as a comment.
Issues Lifecycle ¶
Once an issue is labeled with
in-progress, a team member has begun investigating it. We keep
in-progress issues open until they have been resolved and released. Once released, a comment containing release information will be posted in the issue’s thread.
Contributor License Agreement ¶
All contributors to this project must have a signed Contributor License Agreement (“CLA”) on file with us. The CLA grants us the permissions we need to use and redistribute your contributions as part of the project; you or your employer retain the copyright to your contribution. Before a PR can pass all required checks, our CLA action will prompt you to accept the agreement. Head over to https://cla.vmware.com/ to see your current agreement(s) on file or to sign a new one.
We generally only need you (or your employer) to sign our CLA once and once signed, you should be able to submit contributions to any VMware project.
Note: if you would like to submit an “obvious fix” for something like a typo, formatting issue or spelling mistake, you may not need to sign the CLA.
(Help improve our docs: edit this page on GitHub)