From 5ab7d0001d5a27a4a53bbb59f445fad4949cde29 Mon Sep 17 00:00:00 2001 From: Ayush Agarwal Date: Mon, 20 Sep 2021 20:57:10 +0530 Subject: add a contribution guide --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f2af1cc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +If you're interested in contributing and making [tessen](https://github.com/ayushnix/tessen) better, +please ensure that + +- your bash code doesn't trigger errors or warnings from + [shellcheck](https://github.com/koalaman/shellcheck) + + if you've used `# shellcheck disable` in your bash code, there should be a very good reason for it + +- your bash code has been formatted using [shfmt](https://github.com/mvdan/sh) with the following + settings + + `-i 2 -ci -sr -bn` + +Please raise an [issue](https://github.com/ayushnix/tessen/issues/new/choose) if you have any +questions. + +Thanks! -- cgit v1.2.3