diff options
| author | Dylan Araps <dylan.araps@gmail.com> | 2017-08-01 16:46:37 +1000 |
|---|---|---|
| committer | Dylan Araps <dylan.araps@gmail.com> | 2017-08-01 16:46:37 +1000 |
| commit | 2237894f678d4cfd449d960048819dc3c8f4010c (patch) | |
| tree | 076bdfa5f74916654659d3d9ea262ca1c0ae8ff6 | |
| parent | 2a8c65ea07ad7c0eedd815cca715357075322213 (diff) | |
docs: Move contributing to the wiki.
| -rw-r--r-- | CONTRIBUTING.md | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 3f92f6d..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# 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 - -`wal` can be tested by running `python setup.py test` in the root directory of the repo. - - -### 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" -``` - - -### Comment Style - -All comments must start with a capital letter and end with a full stop `.`. - - -### Running `pywal` - -You can run `pywal` without properly installing it by using the following command: - -```sh -# From the repo directory. -python -m pywal -``` - |