Skip to content

Commit

Permalink
docs: github: streamline environment in issue templates (#6471)
Browse files Browse the repository at this point in the history
Changes:

* Sync bug_report.md with build_issue.md (reword items and add Linux
  kernel item)
* Add a colon to the end of every item (to clarify where to add the
  information)
* Add the Environment section to feature_request.md

The last item is intended as a basic sanity check, as users using an
outdated version of firejail may request something that was already
implemented (for example, see #6461).

Relates to #4515 #6423.
  • Loading branch information
kmk3 authored Sep 13, 2024
1 parent ef5ca49 commit 9bccccf
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 9 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@ _Any other detail that may help to understand/debug the problem_

### Environment

- Linux distribution and version (e.g. "Ubuntu 20.04" or "Arch Linux")
- Firejail version (`firejail --version`).
- Name/version/arch of the Linux kernel (`uname -srm`):
- Name/version of the Linux distribution (e.g. "Ubuntu 20.04" or "Arch Linux"):
- Version of Firejail (`firejail --version`):
- If you use a development version of firejail, also the commit from which it
was compiled (`git rev-parse HEAD`).
was compiled (`git rev-parse HEAD`):

### Checklist

Expand Down
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/build_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ _(Optional) Any other detail that may help to understand/debug the problem_

### Environment

- Name/version/arch of the Linux kernel (e.g. the output of `uname -srm`)
- Name/version of the Linux distribution (e.g. "Ubuntu 20.04" or "Arch Linux")
- Name/version of the C compiler (e.g. "gcc 14.1.1-1")
- Name/version of the libc (e.g. "glibc 2.40-1")
- Version of the Linux API headers (e.g. "linux-api-headers 6.10-1" on Arch Linux)
- Version of the source code being built (e.g. the output of `git rev-parse HEAD`)
- Name/version/arch of the Linux kernel (`uname -srm`):
- Name/version of the Linux distribution (e.g. "Ubuntu 20.04" or "Arch Linux"):
- Name/version of the C compiler (e.g. "gcc 14.1.1-1"):
- Name/version of the libc (e.g. "glibc 2.40-1"):
- Version of the Linux API headers (e.g. "linux-api-headers 6.10-1" on Arch Linux):
- Version of the source code being built (`git rev-parse HEAD`):
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,11 @@ _A clear and concise description of any alternative solutions or features you've
### Additional context

_Add any other context or screenshots about the feature request here._

### Environment

- Name/version/arch of the Linux kernel (`uname -srm`):
- Name/version of the Linux distribution (e.g. "Ubuntu 20.04" or "Arch Linux"):
- Version of Firejail (`firejail --version`):
- If you use a development version of firejail, also the commit from which it:
was compiled (`git rev-parse HEAD`):

0 comments on commit 9bccccf

Please sign in to comment.