diff options
Diffstat (limited to 'docs/contributing/issues_features.rst')
| -rw-r--r-- | docs/contributing/issues_features.rst | 72 |
1 files changed, 0 insertions, 72 deletions
diff --git a/docs/contributing/issues_features.rst b/docs/contributing/issues_features.rst deleted file mode 100644 index 02de2df6..00000000 --- a/docs/contributing/issues_features.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. _issues_features: - -Issues and 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 |