Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-01-24 13:41:28 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update "Issue Tracking"

Browse Source 
- Reorder sections (https://github.com/QubesOS/qubes-doc/pull/1170#issuecomment-874019640)
- Add explanatory text
- Improve wording
- Append periods to complete declarative sentence headings
This commit is contained in:
Andrew David Wong 2021-07-05 05:05:56 -07:00
parent 9bb8a55ef2
commit 65c3dd0f5e
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 34 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
introduction/issue-tracking.md
View File

@ -26,40 +26,47 @@ such as this website) are tracked in
First, let's make sure the issue tracker is the right place.
### I would like to report a security vulnerability
### I need help, have a question, or want to discuss something.
Please see [Reporting Security Issues in Qubes
OS](/security/#reporting-security-issues-in-qubes-os).
We're happy to help, answer questions, and have discussions, but the issue
tracker is not the right place for these activities. Instead, please see [Help,
Support, Mailing Lists, and Forum](/support/).
### I need help, have a question, or want to discuss something
Please see [Help, Support, Mailing Lists, and Forum](/support/).
### I see something that should be changed in the documentation
### I see something that should be changed in the documentation.
We encourage you to submit the change yourself! Please see the [Documentation
Guidelines](/doc/doc-guidelines/) for instructions on how to do so. If it's
something you can't do yourself, please proceed to the next section.
something you can't do yourself, please proceed to open an issue.
### I still want to open an issue
### I would like to report a security vulnerability.
1. Carefully read our issue tracking [guidelines](#guidelines). If your issue
would violate any of the guidelines, **stop**. Please do not submit it.
2. [Search through the existing issues](#search-tips), both open and closed, to
see if your issue already exists. If it does, **stop**. [Do not open a
duplicate.](/doc/issue-tracking/#new-issues-should-not-be-duplicates-of-existing-issues)
Instead, comment on the existing issue.
3. Go [here](https://github.com/QubesOS/qubes-issues/issues/new/choose).
4. Select the [type](#type) of issue you want to open.
5. Enter a descriptive title.
6. Do not delete the provided issue template. Fill out every applicable
section.
7. Make sure to mention any relevant documentation and other issues you've
already seen. We don't know what you've seen unless you tell us. If you
don't list it, we'll assume you haven't seen it.
8. If any sections of the issue template are *truly* not applicable, you may
remove them, **except for the documentation and related issues sections**.
9. Submit your issue.
Thank you! If the vulnerability is confidential, please do not report it in our
public issue tracker. Instead, please see [Reporting Security Issues in Qubes
OS](/security/#reporting-security-issues-in-qubes-os).
### I still want to open an issue.
Great! Thank you for taking the time and effort to help improve Qubes! To
ensure the process is efficient and productive for everyone involved, please
follow these steps:
1. Carefully read our issue tracking [guidelines](#guidelines). If your issue
would violate any of the guidelines, **stop**. Please do not submit it.
2. [Search through the existing issues](#search-tips), both open and closed,
to see if your issue already exists. If it does, **stop**. [Do not open a
duplicate.](/doc/issue-tracking/#new-issues-should-not-be-duplicates-of-existing-issues)
Instead, comment on the existing issue.
3. Go [here](https://github.com/QubesOS/qubes-issues/issues/new/choose).
4. Select the [type](#type) of issue you want to open.
5. Enter a descriptive title.
6. Do not delete the provided issue template. Fill out every applicable
section.
7. Make sure to mention any relevant documentation and other issues you've
already seen. We don't know what you've seen unless you tell us. If you
don't list it, we'll assume you haven't seen it.
8. If any sections of the issue template are *truly* not applicable, you may
remove them, **except for the documentation and related issues sections**.
9. Submit your issue.
10. Respond to any questions the official team asks. For example, you may be
asked to provide specific logs or other additional information.