From 85e664520271128110718cc741579587b3917048 Mon Sep 17 00:00:00 2001 From: rusty-snake Date: Mon, 24 Jun 2019 17:13:29 +0000 Subject: Improve profile PRs (Related to #2739) (#2784) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add contrib/sort.py and .github/pull_request_temp… * Add usage to sort.py * Install sort.py if contrib-install is set * sort.py: 0644 -> 0755 * Update sort.py * Update pull_request_template.md * Remove checkboxes from PR-Template * Update sort.py * Add examples to sort.py * Update pull_request_template.md Fix path to sort.py, it depend on the distro. * Update pull_request_template.md * Update pull_request_template.md add hint about template --- .github/pull_request_template.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/pull_request_template.md (limited to '.github') diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..28ee1c436 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +If you make a PR for new profiles or changeing profiles please do the following: + - The ordering of options follow the rules descripted in [/usr/share/doc/firejail/profile.template](https://github.com/netblue30/firejail/blob/master/etc/templates/profile.template). + Hint: The profile-template is very new, if you install firejail with your package-manager, it maybe missing, therefore, and to follow the latest rules, it is recommended to use the template from the repository. + - Order the arguments of options alphabetical, you can easy do this with the [sort.py](https://github.com/netblue30/firejail/tree/master/contrib/sort.py). + The path to it depends on your distro: + + | Distro | Path | + | ------ | ---- | + | Arch/Fedora | `/lib64/firejail/sort.py` | + | Debian/Ubuntu/Mint | `/usr/lib/x86_64-linux-gnu/firejail/sort.py` | + | local git clone | `contrib/sort.py` | + + Note also that the sort.py script exists only since firejail `0.9.61`. + +If you have no idea how to do one of these, you can open the PR anyway. + +See also [CONTRIBUTING.md](/CONTRIBUTING.md). -- cgit v1.2.3-54-g00ecf