mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-01-14 08:49:45 -05:00
Improve organization, clarify procedure, and clean up source
This commit is contained in:
Andrew David Wong
parent
8b32118e74
commit
27052b83a6
@ -17,70 +17,64 @@ Reporting Bugs
|
|||||||
==============
|
==============
|
||||||
|
|
||||||
One of the most important ways in which you can [contribute to the Qubes OS Project] is by reporting any bugs you have found.
|
One of the most important ways in which you can [contribute to the Qubes OS Project] is by reporting any bugs you have found.
|
||||||
Please note that there is a separate process for [reporting security issues](/security/).
|
|
||||||
|
|
||||||
|
|
||||||
Before you submit a report
|
Important
|
||||||
--------------------------
|
---------
|
||||||
|
|
||||||
Before you submit a bug report, please take a moment to:
|
- **To disclose a security issue confidentially, please see the [Security] page.**
|
||||||
|
- **In all other cases, please do not email individual developers about bugs.**
|
||||||
* Check whether your issue has already been reported.
|
- **Please note that many issues can be resolved by reading the [documentation].**
|
||||||
|
|
||||||
* Determine which venue is most appropriate for it.
|
|
||||||
|
|
||||||
* Read the [documentation] to see whether what you've found is really a bug.
|
|
||||||
|
|
||||||
* Search through the existing [Qubes issues][qubes-issues] by typing your key
|
|
||||||
words in the **Filters** box. Make sure to check both currently open issues,
|
|
||||||
as well as issues that are already closed. If you find an issue that seems to
|
|
||||||
be similar to yours, read through it. If this issue is the same as yours, you
|
|
||||||
can comment with additional information to help the maintainer debug it.
|
|
||||||
Adding a comment will subscribe you to email notifications, which can be
|
|
||||||
helpful in getting important updates regarding the issue. If you don't have
|
|
||||||
anything to add but still want to receive email updates, you can click the
|
|
||||||
"watch" button at the bottom of the comments.
|
|
||||||
|
|
||||||
* Search through our [mailing list] archives by visiting the Google Groups web
|
|
||||||
interfaces for both [qubes-users] and [qubes-devel].
|
|
||||||
|
|
||||||
|
|
||||||
Where to submit your report
|
Where to submit your report
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
Our [GitHub issues][qubes-issues] tracker is not intended for personal,
|
All issues pertaining to the Qubes OS Project (including auxiliary infrastructure such as the [website]) are tracked in [qubes-issues], our GitHub issues tracker.
|
||||||
localized troubleshooting questions, such as problems that affect only a
|
However, [qubes-issues] is not intended for personal, localized troubleshooting questions, such as problems that affect only a specific laptop model.
|
||||||
specific laptop model. Those questions are more likely to be answered in
|
Those questions should instead be asked in [qubes-users], where they are more likely to be answered.
|
||||||
[qubes-users], which receives much more traffic. Instead, GitHub issues are
|
Instead, [qubes-issues] is meant for tracking more general bugs and enhancements that affect a broad range of Qubes users.
|
||||||
meant to track more general bugs and enhancements that affect a broad range of
|
Please see the sections [How to submit a report on GitHub] and [How to submit a report on the mailing lists] below for more information.
|
||||||
Qubes users.
|
|
||||||
|
|
||||||
|
|
||||||
How to copy information out of Dom0
|
|
||||||
-----------------------------------
|
|
||||||
|
|
||||||
See [Copying from (and to) dom0](/doc/copy-from-dom0/).
|
|
||||||
|
|
||||||
|
|
||||||
How to submit a report on the mailing lists
|
|
||||||
-------------------------------------------
|
|
||||||
|
|
||||||
Please see the [mailing list guidelines][mailing list].
|
|
||||||
|
|
||||||
|
|
||||||
How to submit a report on GitHub
|
How to submit a report on GitHub
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
We track all bugs in the [qubes-issues] tracker on GitHub.
|
**Before you submit an issue in [qubes-issues], please check to see whether it has already been reported.**
|
||||||
|
Search through the existing issues by typing your key words in the **Filters** box.
|
||||||
|
Make sure to check both currently open issues, as well as issues that are already closed.
|
||||||
|
If you find an issue that seems to be similar to yours, read through it.
|
||||||
|
If this issue is the same as yours, you can comment with additional information to help the maintainer debug it.
|
||||||
|
Adding a comment will subscribe you to email notifications, which can be helpful in getting important updates regarding the issue.
|
||||||
|
If you don't have anything to add but still want to receive email updates, you can click the "watch" button at the bottom of the comments.
|
||||||
|
|
||||||
When you file a new issue, you should be sure to include the version of Qubes
|
When you file a new issue, you should be sure to include the version of Qubes you're using, as well as versions of related software packages.
|
||||||
your'e using, as well as versions of related software packages. If your issue is
|
If your issue is related to hardware, provide as many details as possible about the hardware, which could include using command-line tools such as `lspci`.
|
||||||
related to hardware, provide as many details as possible about the hardware,
|
|
||||||
which could include using command-line tools such as `lspci`.
|
|
||||||
If you're reporting a bug in a package that is in a [testing] repository, please reference the appropriate issue in the [updates-status] repository.
|
If you're reporting a bug in a package that is in a [testing] repository, please reference the appropriate issue in the [updates-status] repository.
|
||||||
|
Project maintainers really appreciate thorough explanations.
|
||||||
|
It usually helps them address the problem more quickly, so everyone wins!
|
||||||
|
|
||||||
Project maintainers really appreciate thorough explanations. It usually
|
Once your issue is addressed, your GitHub issue may be closed.
|
||||||
helps them address the problem more quickly, so everyone wins!
|
After that, the package containing the fix will move to the appropriate [testing] repository, then to the appropriate stable repository.
|
||||||
|
If you so choose, you can test the fix while it's in the [testing] repository, or you can wait for it to land in the stable repository.
|
||||||
|
If, after testing the fix, you find that it does not really fix your bug, please leave a comment on your issue explaining the situation.
|
||||||
|
When you do, we will receive a notification and respond on your issue or reopen it (or both).
|
||||||
|
Please **do not** create a duplicate issue or attempt to contact the developers individually about your problem.
|
||||||
|
|
||||||
|
|
||||||
|
How to submit a report on the mailing lists
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
Before submitting a report on the mailing lists, please check to see whether your issue has already been reported by searching through the archives.
|
||||||
|
You can do this by visiting the Google Groups web interfaces for both [qubes-users] and [qubes-devel].
|
||||||
|
Please see the [Mailing Lists] page for further information.
|
||||||
|
|
||||||
|
|
||||||
|
How to copy information out of dom0
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
Copying information out of dom0 can be useful when reporting bugs.
|
||||||
|
See [Copying from (and to) dom0] for more information.
|
||||||
|
|
||||||
|
|
||||||
Testing new releases and updates
|
Testing new releases and updates
|
||||||
@ -96,12 +90,17 @@ Please see our guidelines on [how to contribute code].
|
|||||||
|
|
||||||
|
|
||||||
[contribute to the Qubes OS Project]: /doc/contributing/
|
[contribute to the Qubes OS Project]: /doc/contributing/
|
||||||
|
[Security]: /security/
|
||||||
[documentation]: /doc/
|
[documentation]: /doc/
|
||||||
|
[website]: /
|
||||||
[qubes-issues]: https://github.com/QubesOS/qubes-issues/issues
|
[qubes-issues]: https://github.com/QubesOS/qubes-issues/issues
|
||||||
[mailing list]: https://www.qubes-os.org/mailing-lists/
|
[Mailing List]: /mailing-lists/
|
||||||
[qubes-users]: https://groups.google.com/group/qubes-users
|
[qubes-users]: /mailing-lists/#qubes-users
|
||||||
[qubes-devel]: https://groups.google.com/group/qubes-devel
|
[qubes-devel]: /mailing-lists/#qubes-devel
|
||||||
|
[How to submit a report on GitHub]: #how-to-submit-a-report-on-github
|
||||||
|
[How to submit a report on the mailing lists]: #how-to-submit-a-report-on-the-mailing-lists
|
||||||
[testing]: /doc/testing/
|
[testing]: /doc/testing/
|
||||||
[updates-status]: https://github.com/QubesOS/updates-status/issues
|
[updates-status]: https://github.com/QubesOS/updates-status/issues
|
||||||
|
[Copying from (and to) dom0]: /doc/copy-from-dom0/
|
||||||
[how to contribute code]: /doc/contributing/#contributing-code
|
[how to contribute code]: /doc/contributing/#contributing-code
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user