From e264b44682a930f70715ea58cf96e69c87a86b64 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sat, 30 May 2020 00:01:28 +0200 Subject: Add license and basic documentation LICENSE: Add GPL-3.0 license. {{archiso,configs}/*,.editorconfig,.gitlab-ci.yml}: Add SPDX license identifier. Makefile: Add SPDX license identifier. Install the `run_archiso.sh` script as global executable `run_archiso`. Use -D and -t flags to install to install files more generically (without a previous call to install the directory). README.rst: Add README outlining the project's scope, how to build images from the profiles and how to test. AUTHORS.rst: Add list of all direct contributors to the repository. CONTRIBUTING.rst: Add basic contribution guidelines, explaining the linter and the license in use. Closes #7 Closes #3 --- CONTRIBUTING.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.rst (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..5073aa0 --- /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 `_). + +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 check + +Testing +======= + +Contributors are expected to test their contributions by building the releng profile and running the resulting image +using `run_archiso `_. -- cgit v1.2.3-54-g00ecf From eec944cdf7d14cf656c047885010d63a3d9ed3e6 Mon Sep 17 00:00:00 2001 From: nl6720 Date: Thu, 30 Jul 2020 13:37:55 +0300 Subject: CONTRIBUTING.rst: use make lint to run shellcheck `make check` could get extended to include other things besides just linting. --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5073aa0..bffc49d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -17,7 +17,7 @@ All ash and bash scripts are linted using shellcheck: .. code:: bash - make check + make lint Testing ======= -- cgit v1.2.3-54-g00ecf