Skip to content

Commit

Permalink
Move CONTRIBUTING and add PULL_REQUEST_TEMPLATE (#1017)
Browse files Browse the repository at this point in the history
* Move CONTRIBUTING to top level for increased visibility

* Add PR template to guide contributors

* Oops, fix name
  • Loading branch information
shadowspawn committed Aug 13, 2019
1 parent 3b0127b commit fea94a9
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,48 @@
# Pull Request

<!--
The text in these markdown comments is instructions that will not appear in the displayed pull request,
and can be deleted.
Please submit pull requests against the develop branch.
Follow the existing code style. Check the tests succeed, including lint.
npm run test
npm run lint
Don't update the CHANGELOG or command version number. That gets done by maintainers when preparing the release.
Commander currently has zero production dependencies. That isn't a hard requirement, but is a simple story. Requests which
add a dependency are much less likely to be accepted, and we are likely to ask if there alternative approaches to avoid the dependency.
-->

## Problem

<!--
What problem are you solving?
What Issues does this relate to?
Show the broken output if appropriate.
-->

## Solution

<!--
How did you solve the problem?
Show the fixed output if appropriate.
There are a lot of forms of documentation which could need updating for a change in functionality. It
is ok if you want to show us the code to discuss before doing the extra work, and
you should say so in your comments so we focus on the concept first before talking about all the other pieces:
- TypeScript typings
- JSDoc documentation in code
- tests
- README
- examples/
-->

## ChangeLog

<!--
Optional. Suggest a line for adding to the CHANGELOG to summarise your change.
-->
3 changes: 3 additions & 0 deletions .github/CONTRIBUTING.md → CONTRIBUTING.md
Expand Up @@ -16,6 +16,9 @@ Pull Requests will be considered. Please submit pull requests against the develo

Follow the existing code style. Check the tests succeed, including lint.

- `npm run test`
- `npm run lint`

Don't update the CHANGELOG or command version number. That gets done by maintainers when preparing the release.

Useful things to include in your request description are:
Expand Down

0 comments on commit fea94a9

Please sign in to comment.