|
| 1 | +<!-- |
| 2 | +Copyright The Shipwright Contributors |
| 3 | +
|
| 4 | +SPDX-License-Identifier: Apache-2.0 |
| 5 | +--> |
| 6 | + |
| 7 | +# Contributing Guidelines |
| 8 | + |
| 9 | +Welcome to Shipwright Build. We are excited about the prospect of you contributing to our project. Your support is more than welcome! |
| 10 | + |
| 11 | +## Getting Started |
| 12 | + |
| 13 | +We have initial documentation on how to start contributing here: |
| 14 | + |
| 15 | +- Learn how to [change shipwright and try out your changes on a local cluster](/docs/development/local_development.md) |
| 16 | +- Our main [documentation](/docs/) |
| 17 | +- Our [Code of Conduct](/code-of-conduct.md) |
| 18 | + |
| 19 | +## Creating new Issues |
| 20 | + |
| 21 | +We recommend to open an issue for the following scenarios: |
| 22 | + |
| 23 | +- Asking for help or questions. (_Use the **discussion** or **help_wanted** label_) |
| 24 | +- Reporting a Bug. (_Use the **bug** label_) |
| 25 | +- Requesting a new Feature. (_Use the **enhancement** label_) |
| 26 | + |
| 27 | +The Shipwright maintainers can also be reached in our [Kubernetes Slack channel](https://kubernetes.slack.com/archives/C019ZRGUEJC). |
| 28 | + |
| 29 | +## Writing Pull Requests |
| 30 | + |
| 31 | +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: |
| 32 | + |
| 33 | +- Fork the project into your personal Github account |
| 34 | +- Create a new feature branch for your contribution |
| 35 | +- Make your changes |
| 36 | +- If you make code changes, ensure unit tests are passing by running `make test-unit` |
| 37 | +- Open a PR with a nice description and a link to the Github issue where the changes were previously discussed. |
| 38 | + |
| 39 | +## Code review process |
| 40 | + |
| 41 | +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. |
| 42 | + |
| 43 | +The code review should cover: |
| 44 | + |
| 45 | +- Ensure all related tests(unit, integration and e2e) are passing. |
| 46 | +- Ensure the code style is compliant with the [coding conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md) |
| 47 | +- Ensure the code is properly documented, e.g. enough comments where needed. |
| 48 | +- Ensure the code is adding the necessary test cases(unit, integration or e2e) if needed. |
| 49 | + |
| 50 | +## Community Meetings Participation |
| 51 | + |
| 52 | +We run the community meetings every Monday at 13:00 UTC time. |
| 53 | +For each upcoming meeting we generate a new issue where we layout the topics to discuss. |
| 54 | +See our [previous meetings](https://github.com/shipwright-io/build/issues?q=is%3Aissue+label%3Acommunity+is%3Aclosed) outcomes. |
| 55 | +To join, please request an invite in our Slack [channel](https://kubernetes.slack.com/archives/C019ZRGUEJC). |
| 56 | + |
| 57 | +## Contact Information |
| 58 | + |
| 59 | +- [Slack channel](https://kubernetes.slack.com/archives/C019ZRGUEJC) |
0 commit comments