From ae6bc47ebee6096ebbf74c3d21f310411d152893 Mon Sep 17 00:00:00 2001 From: Brian Vanderbusch Date: Sun, 24 Apr 2016 14:36:27 -0500 Subject: [PATCH] added contributing guidelines - includes a pull request template --- .github/CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 0 2 files changed, 27 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..537533c --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# 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 +- 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 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e69de29