Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 5.07 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 5.07 KB
Raw

How to contribute to Splunk Connect for Kubernetes

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability. Please report security issues here.
  • 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, 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 executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request against the develop branch with the patch.
  • Ensure the pull request description clearly describes the problem and solution. Please create an issue and reference it or the relevant existing issue number as part of the title for the PR.

Do you have an idea for a new feature or change an existing one?

  • If you developed a new feature, open a new GitHub pull request against the develop branch with the new feature.
  • Ensure the PR description clearly describes the new feature and the benefits. Include the relevant issue number if applicable.
  • If you have an idea for a new feature, open a GitHub issue that clearly explains the suggested feature and it’s benefits.

Reporting an issue

We use GitHub Issue Tracking to track issues. If you've found a problem which is not a security risk, check to see if it has already been reported. If not, open a new issue. (See the next section for reporting security issues.)

Your issue report should contain a title and a clear description of the issue at the bare minimum. You should include as much relevant information as possible and should at least post a code sample that demonstrates the issue. Please include relevant unit test cases that show how the expected behavior is not occurring. Your goal should be to make it easy for yourself - and others - to reproduce the bug and figure out a fix.

If possible, create an executable test case. This can be very helpful for others to help confirm, investigate, and ultimately fix your issue. Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

When filing an issue, please include answers for questions below:

  • What version of Ruby and Kubernetes are you using?
  • What operating system and processor architecture are you using?
  • What did you do?
  • What did you expect to see?
  • What did you see instead?

When filing an issue, please do NOT include:

  • Internal identifiers such as JIRA tickets
  • Any sensitive information related to your environment, users, etc.

Reporting a security issue

Please do not report security vulnerabilities with public GitHub issue reports. Please report security issues here.

Verifying existing issues

We appreciate any help you can provide us with existing issues. Are you able to reproduce a current issue? If so please provide any additional information that might help us to reproduce or fix the issue. If you can contribute a failing test that’s even better.

Contributing code

If you're planning to submit your change back for inclusion in the main repo, keep a few things in mind:

  • Please review our Code of Conduct.
  • Fork the repo and create your working branch from the develop branch.
  • Include unit tests that fail without your code, and pass with it.
  • Update the (surrounding) documentation, examples, and whatever is affected by your contribution.

By submitting a Contribution to this Work, You agree that Your Contribution is made subject to the primary license in the LICENSE file applicable to this Work. In addition, You represent that: (i) You are the copyright owner of the Contribution or (ii) You have the requisite rights to make the Contribution.

Definitions:

“You” shall mean: (i) yourself if you are making a Contribution on your own behalf; or (ii) your company, if you are making a Contribution on behalf of your company. If you are making a Contribution on behalf of your company, you represent that you have the requisite authority to do so.

"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You for inclusion in, or documentation of, this project/repository. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication submitted for inclusion in this project/repository, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the maintainers of the project/repository.

“Work” shall mean the collective software, content, and documentation in this project/repository.