Welcome to Shipwright Build. We are excited about the prospect of you contributing to our project. Your support is more than welcome!
We have initial documentation on how to start contributing here:
- Learn how to change shipwright and try out your changes on a local cluster
- Our main documentation
- Our Code of Conduct
We recommend to open an issue for the following scenarios:
- Asking for help or questions. (Use the discussion or help_wanted label)
- Reporting a Bug. (Use the bug label)
- Requesting a new Feature. (Use the enhancement label)
The Shipwright maintainers can also be reached in our Kubernetes Slack channel.
Contributions can be submitted by creating a pull request on Github. We recommend you do the following to ensure the maintainers can collaborate on your contribution:
- Fork the project into your personal Github account
- Create a new feature branch for your contribution
- Make your changes
- If you make code changes, ensure unit tests are passing by running
make test-unit - Open a PR with a nice description and a link to the Github issue where the changes were previously discussed.
There is an integration on our Github repository that automatically do things for us. Once a PR is open the tool will assign two members of the project for the code review.
The code review should cover:
- Ensure all related tests(unit, integration and e2e) are passing.
- Ensure the code style is compliant with the coding conventions
- Ensure the code is properly documented, e.g. enough comments where needed.
- Ensure the code is adding the necessary test cases(unit, integration or e2e) if needed.
We run the community meetings every Monday at 13:00 UTC time. For each upcoming meeting we generate a new issue where we layout the topics to discuss. See our previous meetings outcomes. To join, please request an invite in our Slack channel.
- Slack channel
- End-user email list: shipwright-users@lists.shipwright.io
- Developer email list: shipwright-dev@lists.shipwright.io