diff options
author | Kelvin M. Klann <kmk3.code@protonmail.com> | 2023-02-01 04:18:47 -0300 |
---|---|---|
committer | Kelvin M. Klann <kmk3.code@protonmail.com> | 2023-03-24 11:06:31 -0300 |
commit | 707c7917e50a56a759c3ad2f0ad8a6914750d2a3 (patch) | |
tree | 41a1de2a20c7b7b6091f8aed63b68fab1ade5cf9 /CONTRIBUTING.md | |
parent | README.md: remove unicode and non-printing chars (diff) | |
download | firejail-707c7917e50a56a759c3ad2f0ad8a6914750d2a3.tar.gz firejail-707c7917e50a56a759c3ad2f0ad8a6914750d2a3.tar.zst firejail-707c7917e50a56a759c3ad2f0ad8a6914750d2a3.zip |
docs: fix line breaks around elements in markdown
Ensure consistent line breaks around headings, lists and code blocks.
To make them more readable and also more portable (which could help when
previewing/converting files locally).
From the CommonMark Spec (version 0.30, published on 2021-06-19)[1]:
> 1.2 Why is a spec needed?
[...]
> 2. Is a blank line needed before a block quote or heading? Most
> implementations do not require the blank line. However, this can
> lead to unexpected results in hard-wrapped text, and also to
> ambiguities in parsing (note that some implementations put the
> heading inside the blockquote, while others do not). (John Gruber
> has also spoken in favor of requiring the blank lines.)[2]
>
> 3. Is a blank line needed before an indented code block?
> (`Markdown.pl` requires it, but this is not mentioned in the
> documentation, and some implementations do not require it.)
Fixes[3]:
* MD022 Headers should be surrounded by blank lines
* MD031 Fenced code blocks should be surrounded by blank lines
* MD032 Lists should be surrounded by blank lines
Environment: ruby-mdl 0.12.0-1 on Artix Linux.
[1] https://spec.commonmark.org/0.30/#why-is-a-spec-needed-
[2] http://article.gmane.org/gmane.text.markdown.general/2146
[3] https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76d3e709b..9c7dad2dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -1,6 +1,7 @@ | |||
1 | Welcome to firejail, and thank you for your interest in contributing! | 1 | Welcome to firejail, and thank you for your interest in contributing! |
2 | 2 | ||
3 | # Opening an issue: | 3 | # Opening an issue: |
4 | |||
4 | We welcome issues, whether to ask a question, provide information, request a new profile or | 5 | We welcome issues, whether to ask a question, provide information, request a new profile or |
5 | feature, or to report a suspected bug or problem. | 6 | feature, or to report a suspected bug or problem. |
6 | 7 | ||
@@ -9,6 +10,7 @@ our [dedicated issue](https://github.com/netblue30/firejail/issues/1139). | |||
9 | 10 | ||
10 | When submitting a bug report, please provide the following information so that | 11 | When submitting a bug report, please provide the following information so that |
11 | we can handle the report more easily: | 12 | we can handle the report more easily: |
13 | |||
12 | - firejail version. If you're not sure, open a terminal and type `firejail --version`. | 14 | - firejail version. If you're not sure, open a terminal and type `firejail --version`. |
13 | - Linux distribution (so that we can try to reproduce it, if necessary). | 15 | - 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. | 16 | - If you know that the problem did not exist in an earlier version of firejail, please mention it. |
@@ -28,6 +30,7 @@ We take security bugs very seriously. If you believe you have found one, please | |||
28 | emailing us at netblue30@protonmail.com | 30 | emailing us at netblue30@protonmail.com |
29 | 31 | ||
30 | # Opening an pull request: | 32 | # Opening an pull request: |
33 | |||
31 | Pull requests with enhancements, bugfixes or new profiles are very welcome. | 34 | Pull requests with enhancements, bugfixes or new profiles are very welcome. |
32 | 35 | ||
33 | If you want to write a new profile, the easiest way to do this is to use the | 36 | If you want to write a new profile, the easiest way to do this is to use the |