saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-16 09:40:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Document the bug reporting procedure

Browse source
This commit is contained in:
Mike Place 2015-02-18 09:21:04 -07:00
parent 6fedc52a9a
commit 970c32ae8e
3 changed files with 59 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.rst
View file

@ -59,3 +59,10 @@ links should get you started:
* https://github.com/saltstack
* http://docs.saltstack.com/en/latest/topics/development/index.html
Reporting Issues
================
To report an issue with Salt, please follow the guidelines for filing bug reports:
* http://docs.saltstack.com/en/latest/topics/development/reporting_bugs.html

11
doc/faq.rst
View file

@ -14,6 +14,17 @@ and proprietary projects.
.. _`'Halite' web interface`: https://github.com/saltstack/halite
.. _`Apache 2.0 license`: http://www.apache.org/licenses/LICENSE-2.0.html
I think I found a bug! What should I do?
-----------------------------------------
The salt-users mailing list as well as the salt IRC channel can both be helpful
resources to confirm if others are seeing the issue and to assist with
immediate debugging.
To report a bug to the Salt project, please follow the instructions in :doc:
`reporting a bug <topics/development/reporting_bugs>`.
What ports should I open on my firewall?
----------------------------------------

41
doc/topics/development/reporting_bugs.rst Normal file
View file

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