diff options
author | rusty-snake <41237666+rusty-snake@users.noreply.github.com> | 2021-09-17 15:04:42 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-17 15:04:42 +0000 |
commit | 7f2597d6c99098c5e0346513885d1226b400cc67 (patch) | |
tree | ef1f65baa2bd0049ce006fe24411a73ceac8f01c | |
parent | Fix #4509 -- Nextcloud profile broken - needs 3D and system tray access (diff) | |
parent | bug_report.md: clarify message (diff) | |
download | firejail-7f2597d6c99098c5e0346513885d1226b400cc67.tar.gz firejail-7f2597d6c99098c5e0346513885d1226b400cc67.tar.zst firejail-7f2597d6c99098c5e0346513885d1226b400cc67.zip |
Merge pull request #4515 from rusty-snake/rework-issue-template
Rework issue templates
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 64 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 5 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 23 |
3 files changed, 68 insertions, 24 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3700dac20..0f13afc51 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md | |||
@@ -7,54 +7,70 @@ assignees: '' | |||
7 | 7 | ||
8 | --- | 8 | --- |
9 | 9 | ||
10 | Write clear, concise and in textual form. | 10 | ### Description |
11 | 11 | ||
12 | ### Bug and expected behavior | 12 | _Describe the bug_ |
13 | 13 | ||
14 | - Describe the bug. | 14 | ### Steps to Reproduce |
15 | - What did you expect to happen? | ||
16 | 15 | ||
17 | ### No profile and disabling firejail | 16 | _Steps to reproduce the behavior_ |
18 | 17 | ||
19 | - What changed calling `firejail --noprofile /path/to/program` in a terminal? | 18 | 1. Run in bash `LANG=C firejail PROGRAM` (`LANG=C` to get English messages that can be understood by everybody) |
20 | - What changed calling the program by path (e.g. `/usr/bin/vlc`)? | 19 | 2. Click on '....' |
20 | 3. Scroll down to '....' | ||
21 | 4. See error `ERROR` | ||
21 | 22 | ||
22 | ### Reproduce | 23 | ### Expected behavior |
23 | 24 | ||
24 | Steps to reproduce the behavior: | 25 | _What you expected to happen_ |
25 | 26 | ||
26 | 1. Run in bash `firejail PROGRAM` | 27 | ### Actual behavior |
27 | 2. See error `ERROR` | ||
28 | 3. Click on '....' | ||
29 | 4. Scroll down to '....' | ||
30 | 28 | ||
31 | ### Environment | 29 | _What actually happened_ |
30 | |||
31 | ### Behavior without a profile | ||
32 | 32 | ||
33 | - Linux distribution and version (ie output of `lsb_release -a`, `screenfetch` or `cat /etc/os-release`) | 33 | _What changed calling `firejail --noprofile /path/to/program` in a terminal?_ |
34 | - Firejail version (output of `firejail --version`) exclusive or used git commit (`git rev-parse HEAD`) | ||
35 | 34 | ||
36 | ### Additional context | 35 | ### Additional context |
37 | 36 | ||
38 | Other context about the problem like related errors to understand the problem. | 37 | _Any other detail that may help to understand/debug the problem_ |
38 | |||
39 | ### Environment | ||
40 | |||
41 | - Linux distribution and version (e.g. "Ubuntu 20.04" or "Arch Linux") | ||
42 | - Firejail version (`firejail --version`). | ||
43 | - If you use a development version of firejail, also the commit from which it was compiled (`git rev-parse HEAD`). | ||
39 | 44 | ||
40 | ### Checklist | 45 | ### Checklist |
41 | 46 | ||
42 | - [ ] The profile (and redirect profile if exists) hasn't already been fixed [upstream](https://github.com/netblue30/firejail/tree/master/etc). | 47 | - [ ] The issues is caused by firejail (i.e. running the program by path (e.g. `/usr/bin/vlc`) "fixes" it). |
48 | - [ ] I can reproduce the issue without custom modifications (e.g. globals.local). | ||
43 | - [ ] The program has a profile. (If not, request one in `https://github.com/netblue30/firejail/issues/1139`) | 49 | - [ ] The program has a profile. (If not, request one in `https://github.com/netblue30/firejail/issues/1139`) |
50 | - [ ] The profile (and redirect profile if exists) hasn't already been fixed [upstream](https://github.com/netblue30/firejail/tree/master/etc). | ||
44 | - [ ] I have performed a short search for similar issues (to avoid opening a duplicate). | 51 | - [ ] I have performed a short search for similar issues (to avoid opening a duplicate). |
45 | - [ ] If it is a AppImage, `--profile=PROFILENAME` is used to set the right profile. | 52 | - [ ] I'm aware of `browser-allow-drm yes`/`browser-disable-u2f no` in `firejail.config` to allow DRM/U2F in browsers. |
46 | - [ ] Used `LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 PROGRAM` to get english error-messages. | 53 | - [ ] I used `--profile=PROFILENAME` to set the right profile. (Only relevant for AppImages) |
47 | - [ ] I'm aware of `browser-allow-drm yes`/`browser-disable-u2f no` in `firejail.config` to allow DRM/U2F in browsers. | ||
48 | - [ ] This is not a question. Questions should be asked in https://github.com/netblue30/firejail/discussions. | ||
49 | 54 | ||
50 | ### Log | 55 | ### Log |
51 | 56 | ||
52 | <details> | 57 | <details> |
53 | <summary>debug output</summary> | 58 | <summary>Output of <code>firejail /path/to/program</code></summary> |
59 | <p> | ||
60 | |||
61 | ``` | ||
62 | output goes here | ||
63 | ``` | ||
64 | |||
65 | </p> | ||
66 | </details> | ||
67 | |||
68 | <details> | ||
69 | <summary>Output of <code>firejail --debug /path/to/program</code></summary> | ||
54 | <p> | 70 | <p> |
55 | 71 | ||
56 | ``` | 72 | ``` |
57 | OUTPUT OF `firejail --debug PROGRAM` | 73 | output goes here |
58 | ``` | 74 | ``` |
59 | 75 | ||
60 | </p> | 76 | </p> |
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..b8fe40acd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml | |||
@@ -0,0 +1,5 @@ | |||
1 | blank_issues_enabled: true | ||
2 | contact_links: | ||
3 | - name: Question | ||
4 | url: https://github.com/netblue30/firejail/discussions | ||
5 | about: For questions you should use GitHub Discussions. | ||
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..a723cdbde --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md | |||
@@ -0,0 +1,23 @@ | |||
1 | --- | ||
2 | name: Feature request | ||
3 | about: Suggest an idea for this project | ||
4 | title: '' | ||
5 | labels: '' | ||
6 | assignees: '' | ||
7 | --- | ||
8 | |||
9 | ### Is your feature request related to a problem? Please describe. | ||
10 | |||
11 | _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_ | ||
12 | |||
13 | ### Describe the solution you'd like | ||
14 | |||
15 | _A clear and concise description of what you want to happen._ | ||
16 | |||
17 | ### Describe alternatives you've considered | ||
18 | |||
19 | _A clear and concise description of any alternative solutions or features you've considered._ | ||
20 | |||
21 | ### Additional context | ||
22 | |||
23 | _Add any other context or screenshots about the feature request here._ | ||