vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #72 from rebortg/improve/bugreport

Browse Source 
T1457 Migrate Bugreport
This commit is contained in:
Christian Poessinger 2019-07-13 17:37:27 +02:00 committed by GitHub
commit 4cad92e786
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/contributing/issues_features.rst
View File

@ -3,15 +3,46 @@
Issues and Feature requests Issues and Feature requests
=========================== ===========================
For Bug Reports and Feature Requests please take a look at Phabricator here:
https://phabricator.vyos.net
Bug Report / Issue Bug Report / Issue
------------------ ------------------
Issues or bugs are found in any software project. VyOS is not an exception.
To create a Bugreport use the quick link in the left side under the specific All issues should be reported to the developers. This lets the developers know what is not working properly.
project. Please think about the next points: 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
***************************************
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 * provide as much information as you can
* which version you use * which version you use
@ -24,4 +55,3 @@ 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 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 one create a new one by use the quick link in the left side under the specific
project. project.