Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.75 KB

contributing.md

File metadata and controls

42 lines (28 loc) · 1.75 KB
Raw

Contributing to validkube

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Proposing new feature
  • Reporting a bug
  • Submitting a fix

We Develop with Github

We use github to create a tool that can combine various open-source tools to help ensure Kubernetes YAML best practices, hygiene & security.

Guidelines

Pull requests are the best way to propose new tools and propose new feature to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. Add One feature or tool per pull request.
  3. Pull request should include a short description.
  4. Issue that pull request!

Any contributions you make will be under the Apache 2 Software License

In short, when you submit code changes, your submissions are understood to be under the same Apache 2 License 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 screenshots

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Be specific!
  • 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.

License

By contributing, you agree that your contributions will be licensed under its Apache 2 License.

Thank you! ❤️