diff options
| author | Quill <69414602+teslazonda@users.noreply.github.com> | 2026-01-27 18:44:43 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-01-27 09:44:43 +0000 |
| commit | 25c8e20b11ad61d2d9872a1932d373199430af6f (patch) | |
| tree | 24da5fa3160d8efc4f1c60e98ac9a029cc8ebf26 /docs/contributing/issues-features.rst | |
| parent | 47ec485551db9633407995192af11830242f0415 (diff) | |
| download | vyos-documentation-25c8e20b11ad61d2d9872a1932d373199430af6f.tar.gz vyos-documentation-25c8e20b11ad61d2d9872a1932d373199430af6f.zip | |
Proofread docs in the /contributing directory (#1718)
* Proofread upstream-packages.rst
* Fix line length lint errors
* Initial copyedit for testing.rst
* Proofread build-vyos.rst
* Fix line length errors
* Proofread debugging.rst
* Proofread issues-features.rst
* Complete issuesfeatures.rst proofreading
* Initial proofread development.rst
* Revise proofreading of development.rst
* Remove mentions of Phabricator and Jenkins CI
* Fix line length lint errors
* Fix additional line length lint errors
Diffstat (limited to 'docs/contributing/issues-features.rst')
| -rw-r--r-- | docs/contributing/issues-features.rst | 175 |
1 files changed, 85 insertions, 90 deletions
diff --git a/docs/contributing/issues-features.rst b/docs/contributing/issues-features.rst index e57766fc..b1e1d732 100644 --- a/docs/contributing/issues-features.rst +++ b/docs/contributing/issues-features.rst @@ -1,3 +1,5 @@ +:lastproofread: 2025-12-08 + .. _issues_features: ####################### @@ -9,124 +11,117 @@ 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 ----------------------------------- - -You should include the following information: - -* A sequence of configuration commands or a complete configuration file - required to recreate a setup where the bug occurs. - Please avoid partial configs: a sequence of commands is easy to paste into the console, - a complete config is easy to load in a VM, but a partial config is neither! - At least not until we implement a "merge from the CLI" - feature that allows pasting config file chunks into a session. -* The behavior you expect and how it's different from the behavior you observe. - Don't just include command outputs or traffic dumps — - try to explain at least briefly why they are wrong and what they should be. -* A sequence of actions that triggers the bug. - We understand that it's not always possible, but it makes developer's job a lot easier - and also allows any community member to independently confirm - that the bug still exists or if it's already fixed. -* If it's a regression, tell us a VyOS version where the feature still worked correctly. - It's perfect if you can tell exactly which version broke it, - but we understand that it's not always easy or feasible — any working version is acceptable. - -If you aren't certain what the correct behavior is and if what you see is really a bug, -or if you don't have a reproducing procedure that reliably triggers it, -please create a post on the forum or ask in the chat first — -or, if you have a subscription, create a support ticket. -Our team and community members can help you identify the bug and work around it, -then create an actionable and testable bug report. +Issues and bugs occur in every software project, and VyOS is no exception. + +I found a bug, what should I do? +-------------------------------- + +When you find a potential bug, first: + +* Consult the documentation_ to ensure you configured your system + correctly. +* Check if the VyOS community has identified a workaround for the bug through + Slack_ or the VyOS Forum_. + +Ensure the bug is reproducible +------------------------------ + +Include the following information when reporting a bug: + +* A sequence of configuration commands or a complete configuration file needed + to recreate the bug. Avoid partial configurations: a sequence of commands is + easy to paste and a complete configuration is easy to load, but a partial + config is hard to reconstruct. +* Describe the expected behavior and how it differs from what you observe. + Include command outputs or traffic dumps. Explain briefly why these outputs + are incorrect and what the correct behavior should be. +* A sequence of actions that trigger the bug. While not always possible, this + helps developers and community members confirm the issue and verify fixes. +* If the bug is a regression, specify the VyOS version where the feature worked + correctly (any working version is acceptable). Identify the exact version + that the feature stopped working, if possible. + +If you are uncertain whether the behavior is a bug or what the correct behavior +is, or if you lack a reliable reproducing procedure, post on the forum or ask in +chat first. If you have a subscription, create a support ticket. The team and +community can help identify the issue, work around it, and create an actionable +bug report. 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 -1.2 or VyOS 1.3) you will find quick-links for opening a bug-report/feature -request. +To open a bug report or feature request, create an account on +`vyos.dev <https://vyos.dev>`__, the public issue tracker for VyOS. + +When creating a new issue, select the appropriate project and: -* Provide as much information as you can -* Which version of VyOS are you using? ``run show version`` -* How can we reproduce this Bug? +* Provide as much information as you can. +* Specify which VyOS version you are using: ``run show version``. +* Explain how to reproduce the bug. .. _feature_request: Feature Requests ================ -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_ to check 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. +Have an idea to improve VyOS or need a feature that would benefit all users? +Before submitting a feature request, search the public issue tracker +`vyos.dev <https://vyos.dev>`__ to check if a request already exists. You can +also enhance an existing request by providing additional information. -You must create a task before you start working on a feature. -Yes, even if it's a tiny feature — we use the task tracker to generate release notes, -so it's essential that everything is reflected there. +Create a task before starting work on a feature, +even if it is a trivial feature. +The task tracker generates release notes, so all work must be reflected +in the tracker. -You must include at least the following: +Include at least the following information: -* A reasonably detailed description of the feature: what it is, how it's supposed to work, - and how you'd use it. - The maintainers aren't familiar with every feature of every protocol and tool, - and community contributors who are looking for tasks to work on will also - appreciate more information that helps them implement and test a feature. -* Proposed CLI syntax, if the feature requires new commands. - Please include both configuration and operational mode commands, if both are required. +* Provide a detailed description of the feature: what it is, how it works, and + how you would use it. Maintainers may not have experience with every feature, + protocol, and tool in VyOS. Detailed information helps VyOS contributors and + maintainers test new features they are unfamiliar with. +* Include proposed CLI syntax if the feature requires new commands. Provide both + configuration and operational mode commands if both are needed. -You should include the following information: +Consider including the following information: -* Is the feature supported by the underlying component - (FreeRangeRouting, nftables, Kea...) already? -* How you'd configure it by hand there? -* Are there any limitations (hardware support, resource usage)? -* Are there any adverse or non-obvious interactions with other features? - Should it be mutually exclusive with anything? +* Is the feature already supported by the underlying component + (FreeRangeRouting, nftables, Kea, etc.)? +* How would you configure the feature manually within that component? +* Are there any limitations to using the feature + (hardware support, resource usage)? +* Are there any adverse or non-obvious interactions with other features? Should + the feature be mutually exclusive? +* Any relevant documentation or references about the feature. -It's fine if you cannot provide some of that information, but if you can, -it makes the work of developers considerably simpler, -so try to do the research to answer those questions. +You do not need to provide all this information, but if you can, it simplifies +developers' work considerably. Research these questions when possible. Task auto-closing ================= -There is a special status for tasks -where all work on the side of maintainers and contributors is complete: -"Needs reporter action". +A special task status exists for when all work by maintainers and contributors +is complete: **Needs reporter action**. -We assign that status to: +VyOS assigns this status to: -* Feature requests that do not include required information and need clarification. +* Feature requests that do not include required information and need + clarification. * Bug reports that lack reproducing procedures. * Tasks that are implemented and tested by the implementation author, - but require testing in the real-world environment that only the reporter can replicate - (e.g., hardware we do not have, specific network conditions...). + but require testing in the real-world environment that only the reporter + can replicate (for example, hardware VyOS does not support or specific + network conditions). -This is what will happen when a task is set to "Needs reporter action": +When a task is set to **Needs reporter action**: -* If there is no response from the reporter within two weeks, - the task bot will add a comment ("Any news?") to remind the reporter to reply. -* If there is no response after further two weeks, the task will be automatically closed. +* If the reporter does not respond within two weeks, the task bot adds a comment + ("Any news?") to remind the reporter. +* If there is still no response after another two weeks, + the task is closed automatically. -We will not auto-close tasks with any other status -and will not close tasks for the lack of maintainer activity! +We do not auto-close tasks with any other status and do not close tasks due to +lack of maintainer activity. .. _documentation: https://docs.vyos.io .. _Slack: https://slack.vyos.io |
