Skip to content
vohi edited this page Aug 16, 2012 · 6 revisions

Bug reporting

Reproduce against the Latest Code

Please test whether the bug you are encountering is reproducible with development version of CFEngine. To do that, Build the development version and see whether the bug still persists.

If the bug has been fixed, you may still open a bug report, and ask for a bug fix to be put into a next patch release. Note that we only issue patch releases for latest released minor/major release, so no patch releases will be made for (for example) 3.0.x series if 3.1.0 has already been released.

Check with the Community

If the bug seems to be still present (and it is not a crash or another obvious defect), please check with other community members (using IRC or mailing list) whether the observed behaviour is intended. Maybe somebody can provide you with a workaround for the problem that you can use in the meantime.

Gather Information

Please gather information about the problem: version of CFEngine (generally it should be a HEAD of git repository, as the bug should be reproducible in the development version), operating system, CPU architecture, any traces as described on Troubleshooting page, and logs produced by CFEngine.

If the bug is triggered by a particular policy, please trim down the policy to produce a "minimal example". Even better if you can turn it into an acceptance test. Minimal examples are generally added to testsuite for regression testing.

Report the Bug

Open a new issue in bug tracker, describe the problem, and attach all the gathered information. A good way of describing the problem is to answer these three questions:

  1. what did you do?
  2. what you expected to happen?
  3. what happened instead?