firejail/.github/pull_request_template.md
rusty-snake 85e6645202
Improve profile PRs (Related to #2739) (#2784)
* 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
2019-06-24 17:13:29 +00:00

1.1 KiB

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.
    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.
    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.