diff options
author | 2023-02-01 04:18:47 -0300 | |
---|---|---|
committer | 2023-03-24 11:06:31 -0300 | |
commit | 707c7917e50a56a759c3ad2f0ad8a6914750d2a3 (patch) | |
tree | 41a1de2a20c7b7b6091f8aed63b68fab1ade5cf9 /.github/pull_request_template.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 '.github/pull_request_template.md')
-rw-r--r-- | .github/pull_request_template.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3c256dd87..72556609b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md | |||
@@ -1,10 +1,12 @@ | |||
1 | If your PR isn't about profiles or you have no idea how to do one of these, skip the following and go ahead with this PR. | 1 | If your PR isn't about profiles or you have no idea how to do one of these, skip the following and go ahead with this PR. |
2 | 2 | ||
3 | If you submit a PR for new profiles or changing profiles, please do the following: | 3 | If you submit a PR for new profiles or changing profiles, please do the following: |
4 | |||
4 | - The ordering of options follow the rules described in [/usr/share/doc/firejail/profile.template](https://github.com/netblue30/firejail/blob/master/etc/templates/profile.template). | 5 | - The ordering of options follow the rules described in [/usr/share/doc/firejail/profile.template](https://github.com/netblue30/firejail/blob/master/etc/templates/profile.template). |
5 | > Hint: The profile-template is very new. If you install firejail with your package manager, it may be missing. In order to follow the latest rules, it is recommended to use the template from the repository. | 6 | > Hint: The profile-template is very new. If you install firejail with your package manager, it may be missing. In order to follow the latest rules, it is recommended to use the template from the repository. |
6 | - Order the arguments of options alphabetically. You can easily do this with [sort.py](https://github.com/netblue30/firejail/tree/master/contrib/sort.py). | 7 | - Order the arguments of options alphabetically. You can easily do this with [sort.py](https://github.com/netblue30/firejail/tree/master/contrib/sort.py). |
7 | The path to it depends on your distro: | 8 | |
9 | The path to it depends on your distro: | ||
8 | 10 | ||
9 | | Distro | Path | | 11 | | Distro | Path | |
10 | | ------ | ---- | | 12 | | ------ | ---- | |