docs: Add CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing
+Are you interested in contributing to `bat-extras`? That's great!  
+All we ask is that you keep a few things in mind:
+
+
+## DOs:
+
+- Use Bashisms whenever possible (unless it would make the code unclear). These are scripts written specifically for the `bash` shell, and they should take advantage of built-in functionality instead of spawning external processes.
+- Use `awk` or `sed` when it would be faster or less verbose than only using `bash` builtins.
+
+## DON'Ts:
+
+- Include crude or offensive language inside issues or scripts.
+- Use GNU/BSD-only features in external programs like `sed` or `awk`.
+- Use `bash` features that require a Bash version newer than 3.2. 
+- Use `head` in a pipe. See [Issue #19](https://github.com/eth-p/bat-extras/issues/19) for more details.
+- Use any external program that isn't likely to come installed by default (e.g. avoid `perl` and `python`).
+- Automatically reformat scripts unless it's a pull request specifically intended for reformatting. The formatting style that we use differs from what `shfmt` and other shell script formatters will emit.

README.md

@@ -90,3 +90,9 @@ If you wish to use these scripts on a distribution where this is the case, there
 **Verification:**
 
 The build script will attempt to verify the correctness of the "bin" scripts by comparing their output with their source counterparts. It is recommended to let it do this, but you can disable verification with the `--no-verify` option.
+
+ 
+
+## Contributing
+
+If you would like to contribute to `bat-extras`, please feel free to [open an issue on GitHub](https://github.com/eth-p/bat-extras/issues), or make a pull request. If you do the latter, please keep our [contributing guidelines](./CONTRIBUTING.md) in mind.