Contributing guidelines (#140)

* Create Pull Request Template

* added contributing guidelines

- includes a pull request template

* cleanup duped PR docs

* finish fix of duped PR template

* updated contributing guidelines per #140

* comma cleanup, needs tests info update
This commit is contained in:
Brian Vanderbusch 2016-05-18 10:29:22 -05:00
parent bad84d8c51
commit e6ab4167c9
2 changed files with 43 additions and 0 deletions

29
.github/CONTRIBUTING.md vendored Normal file
View file

@ -0,0 +1,29 @@
# Ex-Mode Contributing Guidelines
Current Maintainers:
- [@jazzpi](https://github.com/jazzpi)
- [@LongLiveCHIEF](https://github.com/LongLiveCHIEF)
This project is accepting new maintainers. Interested parties should
1. Open a new issue, titled: `New Maintainer Request`
2. Assign the issue to [@lloeki](https://github.com/lloeki)
3. The last line of your request should `/cc @jazzpi @LongLiveCHIEF`
## Pull Requests
- If the PR *fixes* or should result in the closure of any issues, use the `fixes #` or `closes #` syntax to ensure issue will
close when your PR is merged
- All pull-requests that fix a bug or add a new feature *must* have accompanying tests before they will be merged. If you want
to speed up the merge of your PR, please contribute these tests
- *note*: if you submit a PR but are unsure how to write tests, please begin your PR title with `[needs tests]`
- Please use the [pull request template](PULL_REQUEST_TEMPLATE.md) as a guide for submitting your PR.
- Include a `/cc` for @LongLiveCHIEF and @jazzpi the current maintainers
## Issues
- Be aware of the responsibilities of `ex-mode` vs `vim-mode`
- If you have identified a bug we would welcome any Pull Requests that either:
- Fix the issue
- Create failing tests to confirm the bug

14
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,14 @@
Fixes # .
Changes Proposed in this Pull Request:
-
-
-
I have written tests for:
- [ ] New features introduced
- [ ] Bugs fixed
- [ ] Neither (I'm just enhancing tests!)
@jazzpi @LongLiveCHIEF