diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-12-29 11:10:38 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-12-29 11:10:38 +0100 |
| commit | ed82d6b00e6ed32b3d056f0623822d61c6c599f6 (patch) | |
| tree | 7b24f9ba7f3ce42eb365df1388cda9d400dc56a0 | |
| parent | 1499918804a16051c44d2ee248c067f25e617185 (diff) | |
| download | vyos-documentation-ed82d6b00e6ed32b3d056f0623822d61c6c599f6.tar.gz vyos-documentation-ed82d6b00e6ed32b3d056f0623822d61c6c599f6.zip | |
issue-feature: use documented section style guide
| -rw-r--r-- | docs/contributing/issues-features.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/contributing/issues-features.rst b/docs/contributing/issues-features.rst index e208a3e6..553522a1 100644 --- a/docs/contributing/issues-features.rst +++ b/docs/contributing/issues-features.rst @@ -1,12 +1,14 @@ .. _issues_features: +####################### Issues/Feature requests ======================= .. _bug_report: 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 @@ -14,7 +16,7 @@ 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. @@ -24,7 +26,7 @@ issue prior to opening a bug request. * 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. @@ -40,7 +42,7 @@ information can be very useful. * 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 @@ -49,7 +51,7 @@ 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 -************ +------------ In order to open up a bug-report/feature request you need to create yourself an account on VyOS Phabricator_. On the left side of the specific project (VyOS @@ -60,8 +62,10 @@ request. * Which version of VyOS are you using? ``run show version`` * How can we reproduce this Bug? +.. _feature_request: + 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 |