Merge pull request #60 from shibumi/shibumi/fix-documentation

fixed docs and added styleguide
archlinux · Oct 11, 2019 · 3346a2f · 3346a2f
2 parents 591849e + ae44795
commit 3346a2f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -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
@@ -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`.