github-starred/firejail
2
0
Fork 0
mirror of https://github.com/netblue30/firejail.git synced 2026-05-15 14:16:14 -06:00
Code Issues 531 Projects Packages Wiki Activity Actions 6
firejail/CONTRIBUTING.md
Kelvin M. Klann 707c7917e5 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
2023-03-24 11:06:31 -03:00

2.4 KiB
Raw Blame History

Welcome to firejail, and thank you for your interest in contributing!

Opening an issue:

We welcome issues, whether to ask a question, provide information, request a new profile or feature, or to report a suspected bug or problem.

If you want to request a program profile that we don't already have, please add a comment in our dedicated issue.

When submitting a bug report, please provide the following information so that we can handle the report more easily:

  • firejail version. If you're not sure, open a terminal and type firejail --version.
  • Linux distribution (so that we can try to reproduce it, if necessary).
  • If you know that the problem did not exist in an earlier version of firejail, please mention it.
  • If you are reporting that a program does not work with firejail, please also run firejail with the --noprofile argument. For example, if firejail firefox does not work, please also run firejail --noprofile firefox and let us know if it runs correctly or not.
  • 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.

Please note: if you are running Debian, Ubuntu, Linux Mint, or another related distribution and you installed firejail from your distro's repositories, please ensure that both of the following were installed: firejail and firejail-profiles. A common source of issues is that firejail-profiles was not installed when installing firejail.

We take security bugs very seriously. If you believe you have found one, please report it by emailing us at netblue30@protonmail.com

Opening an pull request:

Pull requests with enhancements, bugfixes or new profiles are very welcome.

If you want to write a new profile, the easiest way to do this is to use the profile template. If you have already written a profile, please make sure it follows the rules described in the template.

If you add a new command, here's the checklist:

  • Update manpages: firejail(1) and firejail-profile(5)
  • Update shell completions
  • Update syntax files (run make syntax or just make)
  • Update --help

Editing the wiki

You are highly encouraged to add your own tips and tricks to the wiki.