Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue template improvements2 #4561

Merged
merged 4 commits into from
Oct 9, 2021
Merged

Issue template improvements2 #4561

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f962070
bug_report.md: use LC_ALL instead of LANG
kmk3 Sep 17, 2021
2b2df66
bug_report.md: use LC_ALL where appropriate
kmk3 Sep 17, 2021
b39ef34
bug_report.md: add checked item example
kmk3 Sep 18, 2021
2072736
bug_report.md: link to markdown formatting help
kmk3 Sep 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ assignees: ''

---

<!--
See the following links for help with formatting:

https://guides.github.com/features/mastering-markdown/
https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
-->

### Description

_Describe the bug_
Expand All @@ -15,7 +22,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 `LC_ALL=C firejail PROGRAM` (`LC_ALL=C` to get a consistent output in English that can be understood by everybody)
2. Click on '....'
3. Scroll down to '....'
4. See error `ERROR`
Expand All @@ -30,7 +37,7 @@ _What actually happened_

### Behavior without a profile

_What changed calling `firejail --noprofile /path/to/program` in a terminal?_
_What changed calling `LC_ALL=C firejail --noprofile /path/to/program` in a terminal?_

### Additional context

Expand All @@ -44,6 +51,12 @@ _Any other detail that may help to understand/debug the problem_

### Checklist

<!--
Note: Items are checked with an "x", like so:

- [x] This is a checked item.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 for this.

I am not sure if this is the prettiest solution (having an own ugly example checkitem). Maybe something like

<!--
- [x] This is a checked item.
-->
### Checklist (check them like this `- [x]`)

Maybe it would make sense to link to https://guides.github.com/features/mastering-markdown/ too. WDYT?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rusty-snake on Sep 19:

+1 for this.

I am not sure if this is the prettiest solution (having an own ugly example
checkitem).

Certainly not a pretty solution, though it's the most dummy-proof one that I
could think of. And considering the formatting of some issues, dummy-proofing
seems like a helpful quality...

Maybe something like

<!--
- [x] This is a checked item.
-->

I had thought about doing this, but it seemed a bit less obvious and it takes
more space. If it works, it's good enough though. Added it.

Maybe it would make sense to link to
https://guides.github.com/features/mastering-markdown/ too. WDYT?

Done.

-->

- [ ] 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`)
Expand All @@ -55,7 +68,7 @@ _Any other detail that may help to understand/debug the problem_
### Log

<details>
<summary>Output of <code>firejail /path/to/program</code></summary>
<summary>Output of <code>LC_ALL=C firejail /path/to/program</code></summary>
<p>

```
Expand All @@ -66,7 +79,7 @@ output goes here
</details>

<details>
<summary>Output of <code>firejail --debug /path/to/program</code></summary>
<summary>Output of <code>LC_ALL=C firejail --debug /path/to/program</code></summary>
<p>

```
Expand Down