diff options
| author |  Kelvin M. Klann <kmk3.code@protonmail.com> | 2023-03-26 04:26:59 -0300 |
|---|---|---|
| committer | Kelvin M. Klann <kmk3.code@protonmail.com> | 2023-03-26 13:52:11 -0300 |
| commit | a516247a1c2715b98c8b6281cbd76d5399f51540 (patch) | |
| tree | 41053cf10af48caa759768eac14ab209b6016bd0 /CONTRIBUTING.md | |
| parent | docs: line-wrap some long lines (diff) | |
| download | firejail-a516247a1c2715b98c8b6281cbd76d5399f51540.tar.gz firejail-a516247a1c2715b98c8b6281cbd76d5399f51540.tar.zst firejail-a516247a1c2715b98c8b6281cbd76d5399f51540.zip | |
docs: line-wrap markdown and use double-spacing
Use two spaces to separate sentences to make the source easier to read
in monospace fonts (such as when editing or reviewing it), especially
for longer paragraphs. The HTML output should still look the same.
Misc: This also removes source-level ambiguity regarding abbreviations
(such as "Mr.") vs the end of sentences and enables moving between
sentences in vi with `(` and `)`, for example.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebc4d3a20..1ae293264 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -15,17 +15,18 @@ a comment in our dedicated issue: | |||
| 15 | 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 |
| 16 | we can handle the report more easily: | 16 | we can handle the report more easily: |
| 17 | 17 | ||
| 18 | - firejail version. If you're not sure, open a terminal and type `firejail --version`. | 18 | - firejail version. If you're not sure, open a terminal and type `firejail |
| 19 | --version`. | ||
| 19 | - 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). |
| 20 | - 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, |
| 21 | - If you are reporting that a program does not work with firejail, please also run firejail with | 22 | please mention it. |
| 22 | the `--noprofile` argument. | 23 | - If you are reporting that a program does not work with firejail, please also |
| 23 | 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 |
| 25 | firefox` does not work, please also run `firejail --noprofile firefox` and | ||
| 24 | let us know if it runs correctly or not. | 26 | let us know if it runs correctly or not. |
| 25 | - You may also try disabling various options provided in | 27 | - You may also try disabling various options provided in |
| 26 | `/etc/firejail/<ProgramName.profile>` until you find out which one causes | 28 | `/etc/firejail/<ProgramName.profile>` until you find out which one causes |
| 27 | problems. | 29 | problems. It will significantly help in finding a solution for your issue. |
| 28 | It will significantly help in finding a solution for your issue. | ||
| 29 | 30 | ||
| 30 | Please note: If you are running Debian, Ubuntu, Linux Mint, or another related | 31 | Please note: If you are running Debian, Ubuntu, Linux Mint, or another related |
| 31 | distribution and you installed firejail from your distro's repositories, please | 32 | distribution and you installed firejail from your distro's repositories, please |