diff options
-rw-r--r-- | .github/pull_request_template.md | 20 | ||||
-rw-r--r-- | CONTRIBUTING.md | 24 |
2 files changed, 22 insertions, 22 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3c256dd87..80945c8ba 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md | |||
@@ -1,17 +1,17 @@ | |||
1 | If your PR isn't about profiles or you have no idea how to do one of these, skip the following and go ahead with this PR. | 1 | If your PR isn't about profiles or you have no idea how to do one of these, skip the following and go ahead with this PR. |
2 | 2 | ||
3 | If you submit a PR for new profiles or changing profiles, please do the following: | 3 | If you submit a PR for new profiles or changing profiles, please do the following: |
4 | - The ordering of options follow the rules described in [/usr/share/doc/firejail/profile.template](https://github.com/netblue30/firejail/blob/master/etc/templates/profile.template). | 4 | - The ordering of options follow the rules described in [/usr/share/doc/firejail/profile.template](https://github.com/netblue30/firejail/blob/master/etc/templates/profile.template). |
5 | > Hint: The profile-template is very new. If you install firejail with your package manager, it may be missing. In order to follow the latest rules, it is recommended to use the template from the repository. | 5 | > Hint: The profile-template is very new. If you install firejail with your package manager, it may be missing. In order to follow the latest rules, it is recommended to use the template from the repository. |
6 | - Order the arguments of options alphabetically. You can easily do this with [sort.py](https://github.com/netblue30/firejail/tree/master/contrib/sort.py). | 6 | - Order the arguments of options alphabetically. You can easily do this with [sort.py](https://github.com/netblue30/firejail/tree/master/contrib/sort.py). |
7 | The path to it depends on your distro: | 7 | The path to it depends on your distro: |
8 | 8 | ||
9 | | Distro | Path | | 9 | | Distro | Path | |
10 | | ------ | ---- | | 10 | | ------ | ---- | |
11 | | Arch/Fedora | `/usr/lib64/firejail/sort.py` | | 11 | | Arch/Fedora | `/usr/lib64/firejail/sort.py` | |
12 | | Debian/Ubuntu/Mint | `/usr/lib/x86_64-linux-gnu/firejail/sort.py` | | 12 | | Debian/Ubuntu/Mint | `/usr/lib/x86_64-linux-gnu/firejail/sort.py` | |
13 | | local git clone | `contrib/sort.py` | | 13 | | local git clone | `contrib/sort.py` | |
14 | 14 | ||
15 | Note also that the sort.py script exists only since firejail `0.9.61`. | 15 | Note also that the sort.py script exists only since firejail `0.9.61`. |
16 | 16 | ||
17 | See also [CONTRIBUTING.md](/CONTRIBUTING.md). | 17 | See also [CONTRIBUTING.md](/CONTRIBUTING.md). |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97730e533..76d3e709b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -9,14 +9,14 @@ our [dedicated issue](https://github.com/netblue30/firejail/issues/1139). | |||
9 | 9 | ||
10 | When submitting a bug report, please provide the following information so that | 10 | When submitting a bug report, please provide the following information so that |
11 | we can handle the report more easily: | 11 | we can handle the report more easily: |
12 | - firejail version. If you're not sure, open a terminal and type `firejail --version`. | 12 | - firejail version. If you're not sure, open a terminal and type `firejail --version`. |
13 | - Linux distribution (so that we can try to reproduce it, if necessary). | 13 | - Linux distribution (so that we can try to reproduce it, if necessary). |
14 | - If you know that the problem did not exist in an earlier version of firejail, please mention it. | 14 | - If you know that the problem did not exist in an earlier version of firejail, please mention it. |
15 | - If you are reporting that a program does not work with firejail, please also run firejail with | 15 | - If you are reporting that a program does not work with firejail, please also run firejail with |
16 | the `--noprofile` argument. | 16 | the `--noprofile` argument. |
17 | For example, if `firejail firefox` does not work, please also run `firejail --noprofile firefox` and | 17 | For example, if `firejail firefox` does not work, please also run `firejail --noprofile firefox` and |
18 | let us know if it runs correctly or not. | 18 | let us know if it runs correctly or not. |
19 | - You may also try disabling various options provided in `/etc/firejail/<ProgramName.profile>` until you find out which one causes problems. It will significantly help to find solution for your issue. | 19 | - You may also try disabling various options provided in `/etc/firejail/<ProgramName.profile>` until you find out which one causes problems. It will significantly help to find solution for your issue. |
20 | 20 | ||
21 | Please note: if you are running Debian, Ubuntu, Linux Mint, or another related | 21 | Please note: if you are running Debian, Ubuntu, Linux Mint, or another related |
22 | distribution and you installed firejail from your distro's repositories, please | 22 | distribution and you installed firejail from your distro's repositories, please |
@@ -36,10 +36,10 @@ If you have already written a profile, please make sure it follows the rules des | |||
36 | 36 | ||
37 | If you add a new command, here's the checklist: | 37 | If you add a new command, here's the checklist: |
38 | 38 | ||
39 | - [ ] Update manpages: firejail(1) and firejail-profile(5) | 39 | - [ ] Update manpages: firejail(1) and firejail-profile(5) |
40 | - [ ] Update shell completions | 40 | - [ ] Update shell completions |
41 | - [ ] Update syntax files (run `make syntax` or just `make`) | 41 | - [ ] Update syntax files (run `make syntax` or just `make`) |
42 | - [ ] Update --help | 42 | - [ ] Update --help |
43 | 43 | ||
44 | # Editing the wiki | 44 | # Editing the wiki |
45 | 45 | ||