summaryrefslogtreecommitdiff
path: root/docs/contributing/issues-features.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-11 17:00:12 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-11 17:00:12 +0100
commit0e33d4179aefd53435c143b2ad125a8c3fba90e4 (patch)
treebab1568eb4a4e1264adfafc7c80e6b393516fd86 /docs/contributing/issues-features.rst
parent2c0b0bf509ead5e301d8f47f75c57ac8f357dd15 (diff)
downloadvyos-documentation-0e33d4179aefd53435c143b2ad125a8c3fba90e4.tar.gz
vyos-documentation-0e33d4179aefd53435c143b2ad125a8c3fba90e4.zip
contribution: restructure entire chapter
- move subchapters to sub-sub chapters and try to have more internal references to e.g. commit rules.
Diffstat (limited to 'docs/contributing/issues-features.rst')
-rw-r--r--docs/contributing/issues-features.rst72
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/contributing/issues-features.rst b/docs/contributing/issues-features.rst
new file mode 100644
index 00000000..fd6225b9
--- /dev/null
+++ b/docs/contributing/issues-features.rst
@@ -0,0 +1,72 @@
+.. _issues_features:
+
+Issues/Feature requests
+=======================
+
+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 via Slack_ or our Forum_
+
+Ensure the problem is reproducible
+**********************************
+
+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 is beneficial to 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? Use e.g. ``run show configuration commands``
+
+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 VyOS Phabricator_. Phabricator_ is located at
+https://phabricator.vyos.net. To create a bug-report use the quick link in the
+left side under the specific project.
+
+* Provide as much information as you can
+* Which version of VyOS are you using? ``run show version``
+* How can we reproduce this Bug?
+
+Feature Request
+---------------
+
+You have an idea of how to make VyOS better or you are in need of a specific
+feature which all users of VyOS would benefit from? To send a feature request
+please search Phabricator_ if there is already a request pending. 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.
+
+.. _documentation: https://vyos.redthedocs.io
+.. _Slack: https://slack.vyos.io
+.. _Forum: https://forum.vyos.io
+.. _Phabricator: https://phabricator.vyos.net \ No newline at end of file