From 86b94454c491fb164a0aeb6292acb6733abdc0ad Mon Sep 17 00:00:00 2001 From: Dylan Araps Date: Sat, 3 Aug 2019 00:35:08 +0300 Subject: [PATCH] docs: update --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 65d1c857..dd7a3f16 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ More information: * [Committing changes](#committing-changes) * [Pull requests](#pull-requests) * [Linting](#linting) +* [Code style](#code-style) @@ -66,3 +67,10 @@ Ensure that the package builds successfully on your system before creating a pul ## Linting All package `build` and `post-install` scripts are subject to checks using `shellcheck`. Packages must pass the linter to be accepted into the repository. Exceptions can be made using `shellcheck disable=SCXXXX` with good reason. + +## Code style + +- Indentation should be 4 spaces. +- Keep variables lowercase unless they're environment variables. +- Use `#!/bin/sh -e`. +- Use `/usr` as the prefix.