diff options
author | Christian Rebischke <chris@nullday.de> | 2019-10-11 17:38:51 +0200 |
---|---|---|
committer | Christian Rebischke <chris@nullday.de> | 2019-10-11 17:45:01 +0200 |
commit | ae44795e210d7a46963bbaf0a853dd8316c53c2d (patch) | |
tree | 1ad74c0238663d92d285d8fdb4e0426f44a137ee | |
parent | 591849ec3e4789b3033fc06e06b53b6ec4aa2a16 (diff) |
fixed docs and added styleguide
Signed-off-by: Christian Rebischke <chris@nullday.de>
-rw-r--r-- | README.md | 2 | ||||
-rw-r--r-- | STYLEGUIDE.md | 13 |
2 files changed, 14 insertions, 1 deletions
@@ -1,5 +1,5 @@ # arch-boxes -[![Actions Status](https://github.com/archlinux/arch-boxes/workflows/CI/badge.svg)](https://github.com/archlinux/arch-boxes/actions) +[![Actions Status](https://github.com/archlinux/arch-boxes/workflows/Github-Actions/badge.svg)](https://github.com/archlinux/arch-boxes/actions) Arch-boxes provides automated builds of the Arch Linux releases for different providers and post-processors. Check the providers or post-processor sections if you want to know diff --git a/STYLEGUIDE.md b/STYLEGUIDE.md new file mode 100644 index 0000000..737f8ff --- /dev/null +++ b/STYLEGUIDE.md @@ -0,0 +1,13 @@ +# Styleguide + +## Python + +All python scripts must be formatted with `yapf` and checked for errors and pep8 with `flake8`. + +## Bash + +All shell scripts must be formatted with `shfmt -i2 -ci` and be syntax checked via `shellcheck`. + +## Vagrant + +Vagrant json configuration has to be checked with `packer validate`. |