From 7b3cd31cfe77d5c4083ba38291567ea48effb1cb Mon Sep 17 00:00:00 2001 From: rusty-snake <41237666+rusty-snake@users.noreply.github.com> Date: Tue, 7 Sep 2021 18:10:34 +0200 Subject: Rework issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 65 +++++++++++++++++++------------ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++ 3 files changed, 69 insertions(+), 24 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3700dac20..d8906af55 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,54 +7,71 @@ assignees: '' --- -Write clear, concise and in textual form. +### Description -### Bug and expected behavior +_Describe the bug_ -- Describe the bug. -- What did you expect to happen? +### Steps to Reproduce -### No profile and disabling firejail +_Steps to reproduce the behavior_ -- What changed calling `firejail --noprofile /path/to/program` in a terminal? -- What changed calling the program by path (e.g. `/usr/bin/vlc`)? +1. Run in bash `LANG=C firejail PROGRAM` (`LANG=C` to get english messages that can be understood by everybody) +2. Click on '....' +3. Scroll down to '....' +4. See error `ERROR` -### Reproduce +### Expected behavior -Steps to reproduce the behavior: +_What you expected to happen_ -1. Run in bash `firejail PROGRAM` -2. See error `ERROR` -3. Click on '....' -4. Scroll down to '....' +### Actual behavior -### Environment +_What actually happened_ + +### Behavior without a profile -- Linux distribution and version (ie output of `lsb_release -a`, `screenfetch` or `cat /etc/os-release`) -- Firejail version (output of `firejail --version`) exclusive or used git commit (`git rev-parse HEAD`) +_What changed calling `firejail --noprofile /path/to/program` in a terminal?_ ### Additional context -Other context about the problem like related errors to understand the problem. +_Any other context you have to understand the problem_ + +### Environment + +- Linux distribution and version (e.g. "Ubuntu 20.04" or "Arch Linux") +- Firejail version (`firejail --version`). + If you use a development version also the commit from which firejail was compiled (`git rev-parse HEAD`). ### Checklist -- [ ] The profile (and redirect profile if exists) hasn't already been fixed [upstream](https://github.com/netblue30/firejail/tree/master/etc). +- [ ] The issues is caused by firejail (i.e running the program by path (e.g. `/usr/bin/vlc`) "fixes" it). +- [ ] I can reproduce the issue without custom modifications (e.g. globals.local). - [ ] The program has a profile. (If not, request one in `https://github.com/netblue30/firejail/issues/1139`) +- [ ] The profile (and redirect profile if exists) hasn't already been fixed [upstream](https://github.com/netblue30/firejail/tree/master/etc). - [ ] I have performed a short search for similar issues (to avoid opening a duplicate). -- [ ] If it is a AppImage, `--profile=PROFILENAME` is used to set the right profile. -- [ ] Used `LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 PROGRAM` to get english error-messages. -- [ ] I'm aware of `browser-allow-drm yes`/`browser-disable-u2f no` in `firejail.config` to allow DRM/U2F in browsers. -- [ ] This is not a question. Questions should be asked in https://github.com/netblue30/firejail/discussions. + - [ ] I'm aware of `browser-allow-drm yes`/`browser-disable-u2f no` in `firejail.config` to allow DRM/U2F in browsers. +- [ ] I used `--profile=PROFILENAME` to set the right profile. (Only relevant for AppImages) ### Log + +
+Output of firejail /path/to/program +

+ +``` +output goes here +``` + +

+
+
-debug output +Output of firejail --debug /path/to/program

``` -OUTPUT OF `firejail --debug PROGRAM` +output goes here ```

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 @@ +blank_issues_enabled: true +contact_links: + - name: Question + url: https://github.com/netblue30/firejail/discussions + 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 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' +--- + +### Is your feature request related to a problem? Please describe. + +_A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_ + +### Describe the solution you'd like + +_A clear and concise description of what you want to happen._ + +### Describe alternatives you've considered + +_A clear and concise description of any alternative solutions or features you've considered._ + +### Additional context + +_Add any other context or screenshots about the feature request here._ -- cgit v1.2.3-54-g00ecf From a138a6545b764d195c139292bf0b0542b72dc25e Mon Sep 17 00:00:00 2001 From: "Kelvin M. Klann" Date: Thu, 16 Sep 2021 09:12:34 -0300 Subject: bug_report.md: remove extraneous newline --- .github/ISSUE_TEMPLATE/bug_report.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d8906af55..efd5d05de 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -54,7 +54,6 @@ _Any other context you have to understand the problem_ ### Log -
Output of firejail /path/to/program

-- cgit v1.2.3-54-g00ecf From 1b1009c408a8f5dbb89937436632d4bcd3047809 Mon Sep 17 00:00:00 2001 From: "Kelvin M. Klann" Date: Thu, 16 Sep 2021 09:16:17 -0300 Subject: bug_report.md: improve grammar Co-authored-by: rusty-snake <41237666+rusty-snake@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index efd5d05de..a326007ef 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -15,7 +15,7 @@ _Describe the bug_ _Steps to reproduce the behavior_ -1. Run in bash `LANG=C firejail PROGRAM` (`LANG=C` to get english messages that can be understood by everybody) +1. Run in bash `LANG=C firejail PROGRAM` (`LANG=C` to get English messages that can be understood by everybody) 2. Click on '....' 3. Scroll down to '....' 4. See error `ERROR` @@ -40,11 +40,11 @@ _Any other context you have to understand the problem_ - Linux distribution and version (e.g. "Ubuntu 20.04" or "Arch Linux") - Firejail version (`firejail --version`). - If you use a development version also the commit from which firejail was compiled (`git rev-parse HEAD`). +- If you use a development version of firejail, also the commit from which it was compiled (`git rev-parse HEAD`). ### Checklist -- [ ] The issues is caused by firejail (i.e running the program by path (e.g. `/usr/bin/vlc`) "fixes" it). +- [ ] The issues is caused by firejail (i.e. running the program by path (e.g. `/usr/bin/vlc`) "fixes" it). - [ ] I can reproduce the issue without custom modifications (e.g. globals.local). - [ ] The program has a profile. (If not, request one in `https://github.com/netblue30/firejail/issues/1139`) - [ ] The profile (and redirect profile if exists) hasn't already been fixed [upstream](https://github.com/netblue30/firejail/tree/master/etc). -- cgit v1.2.3-54-g00ecf From b3212edeed4070131e1e5aeb312f3a638bce41c3 Mon Sep 17 00:00:00 2001 From: "Kelvin M. Klann" Date: Fri, 17 Sep 2021 05:51:36 -0300 Subject: bug_report.md: clarify message Co-authored-by: rusty-snake <41237666+rusty-snake@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a326007ef..0f13afc51 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -34,7 +34,7 @@ _What changed calling `firejail --noprofile /path/to/program` in a terminal?_ ### Additional context -_Any other context you have to understand the problem_ +_Any other detail that may help to understand/debug the problem_ ### Environment -- cgit v1.2.3-54-g00ecf