diff options
author | Kelvin M. Klann <kmk3.code@protonmail.com> | 2023-03-23 16:47:40 -0300 |
---|---|---|
committer | Kelvin M. Klann <kmk3.code@protonmail.com> | 2023-03-26 13:50:54 -0300 |
commit | 79c52d8e971c32d0a19c1bf65d5b8183f852cadc (patch) | |
tree | c13699456c0a41d68407875d88a9b5a012d4f7e3 /CONTRIBUTING.md | |
parent | README.md: improve badges/links (diff) | |
download | firejail-79c52d8e971c32d0a19c1bf65d5b8183f852cadc.tar.gz firejail-79c52d8e971c32d0a19c1bf65d5b8183f852cadc.tar.zst firejail-79c52d8e971c32d0a19c1bf65d5b8183f852cadc.zip |
docs: clarify and improve links and items
Changes:
* Add titles to referenced issues/discussions
* Use relative links for paths
* Separate repo paths from installed paths
* Turn some links and items into lists to make them stand out
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55d8974c4..e1f533dde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -7,8 +7,10 @@ Welcome to firejail, and thank you for your interest in contributing! | |||
7 | We welcome issues, whether to ask a question, provide information, request a new profile or | 7 | We welcome issues, whether to ask a question, provide information, request a new profile or |
8 | feature, or to report a suspected bug or problem. | 8 | feature, or to report a suspected bug or problem. |
9 | 9 | ||
10 | If you want to request a program profile that we don't already have, please add a comment in | 10 | If you want to request a program profile that we don't already have, please add |
11 | our [dedicated issue](https://github.com/netblue30/firejail/issues/1139). | 11 | a comment in our dedicated issue: |
12 | |||
13 | - [Profile requests](https://github.com/netblue30/firejail/issues/1139) | ||
12 | 14 | ||
13 | When submitting a bug report, please provide the following information so that | 15 | When submitting a bug report, please provide the following information so that |
14 | we can handle the report more easily: | 16 | we can handle the report more easily: |
@@ -22,11 +24,15 @@ we can handle the report more easily: | |||
22 | let us know if it runs correctly or not. | 24 | let us know if it runs correctly or not. |
23 | - 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. | 25 | - 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. |
24 | 26 | ||
25 | Please note: if you are running Debian, Ubuntu, Linux Mint, or another related | 27 | Please note: If you are running Debian, Ubuntu, Linux Mint, or another related |
26 | distribution and you installed firejail from your distro's repositories, please | 28 | distribution and you installed firejail from your distro's repositories, please |
27 | ensure that **both** of the following were installed: | 29 | ensure that **all** of the following packages were installed: |
28 | `firejail` and `firejail-profiles`. A common source of issues is that | 30 | |
29 | firejail-profiles was not installed when installing firejail. | 31 | - firejail |
32 | - firejail-profiles | ||
33 | |||
34 | A common source of issues is that firejail-profiles was not installed when | ||
35 | installing firejail. | ||
30 | 36 | ||
31 | ## Security vulnerabilities | 37 | ## Security vulnerabilities |
32 | 38 | ||
@@ -37,8 +43,12 @@ See [SECURITY.md](SECURITY.md). | |||
37 | Pull requests with enhancements, bugfixes or new profiles are very welcome. | 43 | Pull requests with enhancements, bugfixes or new profiles are very welcome. |
38 | 44 | ||
39 | If you want to write a new profile, the easiest way to do this is to use the | 45 | If you want to write a new profile, the easiest way to do this is to use the |
40 | [profile template](https://github.com/netblue30/firejail/blob/master/etc/templates/profile.template). | 46 | profile template: |
41 | If you have already written a profile, please make sure it follows the rules described in the template. | 47 | |
48 | - [etc/templates/profile.template](etc/templates/profile.template) | ||
49 | |||
50 | If you have already written a profile, please make sure it follows the rules | ||
51 | described in the template. | ||
42 | 52 | ||
43 | If you add a new command, here's the checklist: | 53 | If you add a new command, here's the checklist: |
44 | 54 | ||