diff options
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..53ee73a --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,26 @@ +============ +Contributing +============ + +These are the contribution guidelines for parabolaiso. +All contributions fall under the terms of the GPL-3.0-or-later (see `LICENSE <LICENSE>`_). + +Editorconfig +============ + +A top-level editorconfig file is provided. Please configure your text editor to use it. + +Linting +======= + +All ash and bash scripts are linted using shellcheck: + + .. code:: bash + + make lint + +Testing +======= + +Contributors are expected to test their contributions by building the releng profile and running the resulting image +using `run_parabolaiso <scripts/run_parabolaiso.sh>`_. |