19 lines
871 B
Markdown
19 lines
871 B
Markdown
|
# Contributing Guide
|
||
|
|
|
||
|
|
## How to contribute
|
||
|
|
|
||
|
|
* Fork the project and submit a Pull Request (PR)
|
||
|
|
* Explain what the PR fixes or improves
|
||
|
|
* Screenshots for bonus points
|
||
|
|
* Use sensible commit messages
|
||
|
|
* If your PR fixes a separate issue number, include it in the commit message
|
||
|
|
|
||
|
|
## Things to keep in mind
|
||
|
|
|
||
|
|
* Smaller PRs are likely to be merged more quickly than bigger changes
|
||
|
|
* If it is a useful PR it **will** get merged in eventually
|
||
|
|
* [E.g. see how many have already been merged vs. still open](https://github.com/ryanoasis/vim-devicons/pulls)
|
||
|
|
* This project _was_ using [Semantic Versioning 2.0.0](http://semver.org/) but we have since mostly abandoned that
|
||
|
|
* Try to add to the unit tests where possible so we can maintain our test coverage
|
||
|
|
* Issues not filled out with the template will be closed straight away and will only be responded to once filled properly
|