Skip to content

Commit

Permalink
[.github]Add templates for issues, PRs, and Contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Troy Connor committed Jan 28, 2017
1 parent 560670e commit 9d722fd
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing to N

### If opening up an issue, please search current issue to see if that issue exists.

### If you want to contribute to code and/or docs, please fork this repo

### If you are contributing to docs and making a PR please include in the PR notes

_i.e. * Bumped version number up in bin/n_

### If your PR solves an issue, please provide issue number in your commit or in your PR notes

_i.e. Bumped version number up in bin/n. Solves issue #435_

### Versioning will be at the discretion of the contributors.

#### _Disclaimer: Hate speech of any kind is no tolerated_
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Issue Template:

### Describe issue including what OS you are using

_i.e. I'm using MacOS Sierra_

### Describe what version of N you have
_i.e. n --version output: 2.1.4_


### Describe how you installed N

* _i.e. npm install -g n_
* _i.e. make install_

### Steps to reproduce issue _1.2.3_
_i.e._
1. n latest
2. couldn't pull latest from source

### Describe the results you received

_i.e. blank screen_
### Describe the results you expected

_i.e. I was supposed to see the lastet being pulled from source_


### What version of npm you are using

_i.e. npm --version output: 4.0.5_

### Additional information you deem important (e.g. issue happens only occasionally):

* Output of `which n:`
* Output of `node -v:`

#### (paste your output here)
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Pull Request Template:

### Describe what you did
_i.e. bumped version number up in bin/n_

### How you did it

_i.e. bumped version number up in bin/n_

### How to verify it doesn't effect the functionality of n

_i.e. n --version output: 2.1.4_

### If this solves an issue, please put issue in PR notes.

_i.e. n --version output: 2.1.4 solves issue #453_


### If this solves an issue, please include the output of issue that had problems and then the fixed output from the same command.



### Squash any unnecessary commits to keep history clean as possible

### Place description for the changelog in PR so we can tally all changes for any future release
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ If you are searching for the latest version of `n` below 2.x.x, check out the br
* Ted Gaydos – [@tedgaydos](https://github.com/tedgaydos)
* Travis Webb – [@tjwebb](https://github.com/tjwebb)

Please Read [Contributing Docs](./.github/CONTRIBUTING.MD)

## License

(The MIT License)
Expand Down

0 comments on commit 9d722fd

Please sign in to comment.