diff options
| author | David Runge <dvzrv@archlinux.org> | 2020-05-30 00:01:28 +0200 |
|---|---|---|
| committer | David Runge <dvzrv@archlinux.org> | 2020-07-29 14:27:48 +0200 |
| commit | e264b44682a930f70715ea58cf96e69c87a86b64 (patch) | |
| tree | 2fe053fd799a5c19d56338301d8cbe35a35bec10 /CONTRIBUTING.rst | |
| parent | 47e11125e4672fc3448caefa6728439160daedd3 (diff) | |
| download | archiso-e264b44682a930f70715ea58cf96e69c87a86b64.tar.gz archiso-e264b44682a930f70715ea58cf96e69c87a86b64.tar.bz2 | |
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
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..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 <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 <scripts/run_archiso.sh>`_. |
