reporting_bugs.rst 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .. _reporting-bugs:
  2. ==============
  3. Reporting Bugs
  4. ==============
  5. Salt uses GitHub to track open issues and feature requests.
  6. To file a bug, please navigate to the `new issue page for the Salt project`__.
  7. .. __: https://github.com/saltstack/salt/issues/new
  8. In an issue report, please include the following information:
  9. * The output of ``salt --versions-report`` from the relevant machines. This
  10. can also be gathered remotely by using ``salt <my_tgt>
  11. test.versions_report``.
  12. * A description of the problem including steps taken to cause the issue to
  13. occur and the expected behaviour.
  14. * Any steps taken to attempt to remediate the problem.
  15. * Any configuration options set in a configuration file that may be relevant.
  16. * A reproduceable test case. This may be as simple as an SLS file that
  17. illustrates a problem or it may be a link to a repository that contains a
  18. number of SLS files that can be used together to re-produce a problem. If
  19. the problem is transitory, any information that can be used to try and
  20. reproduce the problem is helpful.
  21. * [Optional] The output of each salt component (master/minion/CLI) running
  22. with the ``-ldebug`` flag set.
  23. .. note::
  24. Please be certain to scrub any logs or SLS files for sensitive data!