Skip to content

Contribution Guidelines

Thanks for your interest in contributing to this project. This page will give you a quick overview of how things are organized and, most importantly, how to get involved. Everyone is welcome to contribute, and we value everybody's contribution.

Issues/Bugs

If something seems broken, isn't working as you expect or could be explained in a clearer/better way in the current documentation, please reach out using Splunk Answers.

Before doing so however, please consider checking the following:

  • You're using the latest version of the application or there is no fix listed for your issue
  • You've read the documentation here
  • You've checked the issue you've experienced hasn't already been reported

When doing so, please also consider:

  • Using GitHub flavored Markdown to format your issue, especially for code or error messages to improve readability. For example, adding screenshots and or using backticks (```) to format error message/stack traces/code.

Conventions

Checks are prefixed with an ID based on the check type. For example:

  • CHKOVR000
  • CHKDET000
  • CHKSCH000

Try to follow that convention used for default checks provided out of the box. Also think about providing good defaults.