Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.17 KB

Contribute to Kubeiql

Kubeiql is maintained by Yipee.io, a CA, Inc. Acclerator project. External contributions are welcome and much appreciated. Just follow these easy steps to contribute.

Code Standard and Guideline

For consistency, we ask that you adhere to some basic code guidelines when contributing to the Kubeiql. Please run gofmt on your code before submitting a pull request.

Our Development Process

Pull Requests

We welcome and encourage pull requests. When we get a pull request, it is peer reviewed and sent to QA for integration and smoke testing. Next, a core team member signs off and performs the pull request merge. We'll provide updates and feedback throughout the process to keep you informed.

Follow these steps for pull requests:

  1. Fork the repo and create your branch from master.
  2. For any new code, add unit tests.
  3. Verify that the test suite passes.
  4. Verify that your code follows the Code Standard Guideline
  5. If you haven't already, complete the Contributor License Agreement ("CLA").

Contributor License Agreement ("CLA")

To get started, sign the Contributor License Agreement.

Bugs

We work hard to avoid them, but they still happen. We use GitHub issues to track bugs and ongoing work for Kubeiql.

Known Issues

We also use GitHub issues for updates to known issues, including alerts when fixes are in progress.

Reporting New Issues

Before filing a new issue, check Known Issues to see if your problem already exists. When reporting a new issue, provide as much detail as possible. The more information, the easier it is to debug and the faster you'll get a fix.

Tips:

  • A description. What did you expect to happen? What actually happened? Why do you think the behavior was incorrect?
  • What Kubernetes version are you running? Have you seen the same issue/behavior on other versions too?
  • Anything else that seems relevant.

License

By contributing to kubeiql, you agree that your contributions will be licensed under its license.