diff options
Diffstat (limited to '.github/pull_request_template.md')
-rw-r--r-- | .github/pull_request_template.md | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3c256dd87..4a7998e87 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md | |||
@@ -1,17 +1,21 @@ | |||
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, |
2 | skip the following and go ahead with this PR. | ||
2 | 3 | ||
3 | If you submit a PR for new profiles or changing profiles, please do the following: | 4 | If you submit a PR for new profiles or changing profiles, please do the |
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 | following: |
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). | ||
7 | The path to it depends on your distro: | ||
8 | 6 | ||
9 | | Distro | Path | | 7 | - The ordering of options follow the rules described in |
10 | | ------ | ---- | | 8 | [etc/templates/profile.template](../blob/master/etc/templates/profile.template) |
11 | | Arch/Fedora | `/usr/lib64/firejail/sort.py` | | 9 | (/usr/share/doc/firejail/profile.template when installed). |
12 | | Debian/Ubuntu/Mint | `/usr/lib/x86_64-linux-gnu/firejail/sort.py` | | 10 | - Order the arguments of options alphabetically. You can easily do this with |
13 | | local git clone | `contrib/sort.py` | | 11 | [sort.py](../blob/master/contrib/sort.py). |
14 | 12 | ||
15 | Note also that the sort.py script exists only since firejail `0.9.61`. | 13 | The path to it depends on your distro: |
16 | 14 | ||
17 | See also [CONTRIBUTING.md](/CONTRIBUTING.md). | 15 | | Distro | Path | |
16 | | ------ | ---- | | ||
17 | | Arch/Fedora | `/usr/lib64/firejail/sort.py` | | ||
18 | | Debian/Ubuntu/Mint | `/usr/lib/x86_64-linux-gnu/firejail/sort.py` | | ||
19 | | local git clone | `contrib/sort.py` | | ||
20 | |||
21 | See also [CONTRIBUTING.md](../blob/master/CONTRIBUTING.md). | ||