Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorAndreas Baumann <mail@andreasbaumann.cc>2022-02-01 19:15:22 +0100
committerAndreas Baumann <mail@andreasbaumann.cc>2022-02-01 19:15:22 +0100
commit30fa0d760efa7404b85829ac144b88aaf980525e (patch)
tree6de0e5eda482e490317ffa8d1103442351b89b00 /CONTRIBUTING.rst
parenta231f14524e85f7e751c6ce95d426afed19df1a1 (diff)
parentf8225782e27e581a97d807a9d152b94771ee559a (diff)
merged with upstream
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..bffc49d
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,26 @@
+============
+Contributing
+============
+
+These are the contribution guidelines for archiso.
+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_archiso <scripts/run_archiso.sh>`_.