diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 69 |
1 files changed, 45 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76d3e709b..1ae293264 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -1,38 +1,58 @@ | |||
| 1 | # Contributing | ||
| 2 | |||
| 1 | Welcome to firejail, and thank you for your interest in contributing! | 3 | Welcome to firejail, and thank you for your interest in contributing! |
| 2 | 4 | ||
| 3 | # Opening an issue: | 5 | ## Opening an issue |
| 4 | We welcome issues, whether to ask a question, provide information, request a new profile or | 6 | |
| 5 | feature, or to report a suspected bug or problem. | 7 | We welcome issues, whether to ask a question, provide information, request a |
| 8 | new profile or feature, or to report a suspected bug or problem. | ||
| 9 | |||
| 10 | If you want to request a program profile that we don't already have, please add | ||
| 11 | a comment in our dedicated issue: | ||
| 6 | 12 | ||
| 7 | If you want to request a program profile that we don't already have, please add a comment in | 13 | - [Profile requests](https://github.com/netblue30/firejail/issues/1139) |
| 8 | our [dedicated issue](https://github.com/netblue30/firejail/issues/1139). | ||
| 9 | 14 | ||
| 10 | 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 |
| 11 | we can handle the report more easily: | 16 | we can handle the report more easily: |
| 12 | - firejail version. If you're not sure, open a terminal and type `firejail --version`. | 17 | |
| 18 | - firejail version. If you're not sure, open a terminal and type `firejail | ||
| 19 | --version`. | ||
| 13 | - Linux distribution (so that we can try to reproduce it, if necessary). | 20 | - 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. | 21 | - If you know that the problem did not exist in an earlier version of firejail, |
| 15 | - If you are reporting that a program does not work with firejail, please also run firejail with | 22 | please mention it. |
| 16 | the `--noprofile` argument. | 23 | - If you are reporting that a program does not work with firejail, please also |
| 17 | For example, if `firejail firefox` does not work, please also run `firejail --noprofile firefox` and | 24 | run firejail with the `--noprofile` argument. For example, if `firejail |
| 18 | let us know if it runs correctly or not. | 25 | firefox` does not work, please also run `firejail --noprofile firefox` and |
| 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. | 26 | let us know if it runs correctly or not. |
| 20 | 27 | - You may also try disabling various options provided in | |
| 21 | Please note: if you are running Debian, Ubuntu, Linux Mint, or another related | 28 | `/etc/firejail/<ProgramName.profile>` until you find out which one causes |
| 29 | problems. It will significantly help in finding a solution for your issue. | ||
| 30 | |||
| 31 | 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 | 32 | distribution and you installed firejail from your distro's repositories, please |
| 23 | ensure that **both** of the following were installed: | 33 | ensure that **all** of the following packages were installed: |
| 24 | `firejail` and `firejail-profiles`. A common source of issues is that | 34 | |
| 25 | firejail-profiles was not installed when installing firejail. | 35 | - firejail |
| 36 | - firejail-profiles | ||
| 26 | 37 | ||
| 27 | We take security bugs very seriously. If you believe you have found one, please report it by | 38 | A common source of issues is that firejail-profiles was not installed when |
| 28 | emailing us at netblue30@protonmail.com | 39 | installing firejail. |
| 40 | |||
| 41 | ## Security vulnerabilities | ||
| 42 | |||
| 43 | See [SECURITY.md](SECURITY.md). | ||
| 44 | |||
| 45 | ## Opening a pull request | ||
| 29 | 46 | ||
| 30 | # Opening an pull request: | ||
| 31 | Pull requests with enhancements, bugfixes or new profiles are very welcome. | 47 | Pull requests with enhancements, bugfixes or new profiles are very welcome. |
| 32 | 48 | ||
| 33 | If you want to write a new profile, the easiest way to do this is to use the | 49 | If you want to write a new profile, the easiest way to do this is to use the |
| 34 | [profile template](https://github.com/netblue30/firejail/blob/master/etc/templates/profile.template). | 50 | profile template: |
| 35 | If you have already written a profile, please make sure it follows the rules described in the template. | 51 | |
| 52 | - [etc/templates/profile.template](etc/templates/profile.template) | ||
| 53 | |||
| 54 | If you have already written a profile, please make sure it follows the rules | ||
| 55 | described in the template. | ||
| 36 | 56 | ||
| 37 | If you add a new command, here's the checklist: | 57 | If you add a new command, here's the checklist: |
| 38 | 58 | ||
| @@ -41,6 +61,7 @@ If you add a new command, here's the checklist: | |||
| 41 | - [ ] Update syntax files (run `make syntax` or just `make`) | 61 | - [ ] Update syntax files (run `make syntax` or just `make`) |
| 42 | - [ ] Update --help | 62 | - [ ] Update --help |
| 43 | 63 | ||
| 44 | # Editing the wiki | 64 | ## Editing the wiki |
| 45 | 65 | ||
| 46 | You are highly encouraged to add your own tips and tricks to the [wiki](https://github.com/netblue30/firejail/wiki). | 66 | You are highly encouraged to add your own tips and tricks to the |
| 67 | [wiki](https://github.com/netblue30/firejail/wiki). | ||