summaryrefslogtreecommitdiff
path: root/docs/contributing/issues_features.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2019-07-10 23:41:58 +0200
committerrebortg <github@ghlr.de>2019-07-10 23:41:58 +0200
commite5261091b51cdb302ba3fbf52e941b1468e30fac (patch)
tree6176b9fd4d1804b677ca2882a2f54c35218d1452 /docs/contributing/issues_features.rst
parent1cee9fe391f0b49e7490a8369d1e29ceab228024 (diff)
downloadvyos-documentation-e5261091b51cdb302ba3fbf52e941b1468e30fac.tar.gz
vyos-documentation-e5261091b51cdb302ba3fbf52e941b1468e30fac.zip
T1457 Migrate Bugreport
Diffstat (limited to 'docs/contributing/issues_features.rst')
-rw-r--r--docs/contributing/issues_features.rst46
1 files changed, 38 insertions, 8 deletions
diff --git a/docs/contributing/issues_features.rst b/docs/contributing/issues_features.rst
index de55128e..d61d5b6c 100644
--- a/docs/contributing/issues_features.rst
+++ b/docs/contributing/issues_features.rst
@@ -3,15 +3,46 @@
Issues and Feature requests
===========================
-For Bug Reports and Feature Requests please take a look at Phabricator here:
-
-https://phabricator.vyos.net
-
Bug Report / Issue
------------------
+Issues or bugs are found in any software project. VyOS is not an exception.
+
+All issues should be reported to the developers. This lets the developers know what is not working properly.
+Without this sort of feedback every developer will believe that everything is working correctly.
+
+I have found a bug, what should I do?
+*************************************
+
+When you believe you have found a bug, it is always a good idea to verify the issue prior to opening a bug request.
+
+* Consult the documentation to ensure that you have configured your system correctly.
+* Get community support `slack <https://slack.vyos.io/>`_ or `forum <https://forum.vyos.io/>`_.
+
+Ensure that the problem is reproducible
+***************************************
-To create a Bugreport use the quick link in the left side under the specific
-project. Please think about the next points:
+When you are able to verify that it is actually a bug, spend some time to document how to reproduce the issue.
+This documentation can be invaluable. When you wish to have a developer fix a bug that you found, helping them reproduce the issue benefits everyone.
+Be sure to include information about the hardware you are using, commands that you were running, any other activities that you may have been doing at the time.
+This additional information can be very useful.
+
+* What were you attempting to achieve?
+* What was the configuration prior to the change?
+* What commands did you use?
+
+Include output
+**************
+
+The output you get when you find a bug can provide lots of information.
+If you get an error message on the screen, copy it exactly. Having the exact message can provide detail that the developers can use.
+Like wise if you have any log messages that also are from the time of the issue, include those.
+They may also contain information that is helpful for the development team.
+
+Report a Bug
+************
+
+Create an account on the VyOS Phabricator. VyOS Phabricator is at https://phabricator.vyos.net.
+To create a Bugreport use the quick link in the left side under the specific project.
* provide as much information as you can
* which version you use
@@ -23,5 +54,4 @@ Feature Request
To send a Feature Request please search Phabricator if there is already a
feature request targeting your request. You can enhance it or if you don't find
one create a new one by use the quick link in the left side under the specific
-project.
-
+project. \ No newline at end of file