Skip to content

Latest commit

 

History

History
64 lines (35 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

64 lines (35 loc) · 3.35 KB

How to contribute 👋

Welcome to k8s-crafts! Thanks for finding the time to contribute to the k8s-crafts projects!

We appreciate all contributions, whether they involve a large feature, a bug fix, or just an update to documentation. Please follow the guidelines below to make it easier for us to address your report and review your contributions.

General guidelines

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, please open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an test case demonstrating the expected behavior that is not occurring.

  • When possible, please follow the available issue templates.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number in PR description if applicable (e.g. Fixes #100, Related to #101).

  • All commmits must be signed. See references for more details.

  • The maintainers will get to your as soon as possible.

Do you intend to add a new feature or change an existing one?

  • Suggest your suggestions by opening a new issue. Be sure to clearly state your ideas and any supporting reasons so we can have some contexts and grounds to validate them.

  • You can also ask maintainers directly through our mailing list. Generally, please use the GitHub issues.

Do you want to suggest updates to documentations?

  • Please open a new issue and clearly state your suggestions. All contributions are valuable even if it is just a typo.

  • As of now, we don't have the capacities to provide documentations in languages (i.e. only English). If you can help us with that, we truly appreciate that.

Do you have questions about the source code?

  • You can always ask maintainers directly through our mailing list.

For developers

Please see Developer Guides documentation on how to get started with developing the plugin.

For users

Please see User Guides documentation on how to use the plugin.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

For more details, see Code of Conduct.

License

The project follows MIT License license.