diff options
| -rw-r--r-- | CONTRIBUTING.md | 34 |
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" +``` |