summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDylan Araps <dylan.araps@gmail.com>2017-06-26 10:34:32 +1000
committerDylan Araps <dylan.araps@gmail.com>2017-06-26 10:34:32 +1000
commitcdfda9fdb8b64573525cd0a1248d5a692d67a61a (patch)
tree6d4118efcf59d475698a74a80e9ca9ffd1d97434 /CONTRIBUTING.md
parenteab524f372f49560009c327e61eb61f01d078f5a (diff)
DOCS: CONTRIBUTING
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d9315ca
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,34 @@
+# Contributing
+
+Welcome to `pywal`, here's how you can contribute.
+
+
+### Environment Details
+
+- Linux
+- Python `3.6`
+
+
+### Development Dependencies
+
+All contributions and changes to `wal` must pass both `flake8` and `pylint` linters unless you have ample reason for disabling a specific message. Travis.ci will automatically run the tests every time you push a new commit to a Pull Request on the repo.
+
+```py
+pip install flake8 pylint
+```
+
+
+### Tests
+
+Tests haven't been written yet.
+
+
+### Commit Message Style
+
+I'm not fussed if you don't follow this one too closely as I'm guilty of forgetting at times. The commit style that should be used on this repo is as follows:
+
+```sh
+# topic: Short sentence about changes. Closes #issue_number
+# Example:
+git commit -m "export: Added export format for emacs. Closes #11"
+```