Welcome to docs.opsview.com

Contributing

We welcome all contributions to Opsview - it is an open source project!

You can help by raising bugs, fixing documentation, submitting patches or just letting people know about Opsview!

Contributing code

See the styleguide for general advice on changes to Opsview - we use this ourselves!

Types of patches

Major changes

If you are going to make a major change to Opsview, it would be useful to drop an email to the opsview-devel mailing list of your intentions, in case anyone else is working on a similar piece. We can also give advice on the best approach and highlight any areas of impact.

Minor enhancements

You can just submit minor enhancements. However, as with major changes, it may be useful to inform us on the mailing list about these changes first to check there are no areas of impact.

Bug fixes

Ideally you should create a failing test case for the bug you are trying to fix, either programatically or in clear steps.

Security fixes

If you find a security issue with Opsview, please inform us privately first. After evaluation, we will reply with plans for how and when the issue would be resolved.

If the issue is confirmed, we will:

  • fix in all supported versions of Opsview in our code repository
  • raise a publicly accessible jira with details of the issue, the impact and the patches
  • release the latest Enterprise version as soon as possible
  • release the newest community version as part of the next release cycle
  • credit you with discovering the issue

Patch submission

As far as possible, all patches should be produced by an svn diff within the top directory of an up-to-date trunk. If this is not possible, then a diff -ur <copy of original directory> <modified directoy> should be used instead.

Patches should be submitted via email on the opsview-devel mailing list.

By submitting a patch, you are agreeing that:

  • the patch is your own work and may legally be used in this project
  • the copyright of your patch is given to Opsera Limited, so we may publish it in accordance with the rest of Opsview

We will add your patch into our tracking system, evaluate your patch and inform you of one of the three outcomes:

  • that the patch will not be applied to the codebase, and give reasons why
  • that the patch could be applied, but there may be additional work required
  • that we will incorporate your patch, and assign to a future release

If there has not been a response, feel free to follow up on the email - we're all very busy!

Patch accepted

If we apply your patch into the core code, we will:

  • credit you in the commit for the particular patch
  • credit you in the CHANGES file for the appropriate release
  • credit you in the announcement for the appropriate release
  • add an acknowledgement on our main opsview.org site

For contributors who consistently make a high standard of patches which are incorporated into the core code base, we will give commit access to our code repository.