mirror of
https://github.com/dylanaraps/pywal.git
synced 2025-02-08 06:19:41 +01:00
DOCS: CONTRIBUTING
This commit is contained in:
parent
eab524f372
commit
cdfda9fdb8
34
CONTRIBUTING.md
Normal file
34
CONTRIBUTING.md
Normal file
@ -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"
|
||||
```
|
Loading…
Reference in New Issue
Block a user