Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 2.48 KB
Raw

Contributing to Kubernetes Best Practices

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

  • Reporting a bug
  • Discussing the current state of the the guide
  • Proposing new features
  • Submitting a fix or a new feature/term
  • Becoming a maintainer

We Develop and growth with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We use Github Flow, So all code changes happen through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. Prefer write the commits using Convetional Commits.
  3. If you've added a doc or example, make it understandable and clear.
  4. Make sure your code lints.
  5. Issue that pull request!

Any contributions you make will be under the Apache Software License

In short, when you submit code changes, your submissions are understood to be under the same Apache 2.0 January 2004 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background and sample

This is an example of a bug report.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a consistent coding style

Choose the standart coding style based on the language, framework or file, that you will submit

References

This document was adapted from the open-source contribution guidelines created by briandk