mirror of
https://github.com/tj/n.git
synced 2024-11-21 18:48:57 +01:00
Rework and add github templates
This commit is contained in:
parent
08e871fc79
commit
e81edac2e4
12
.github/CONTRIBUTING.md
vendored
12
.github/CONTRIBUTING.md
vendored
@ -4,15 +4,17 @@
|
||||
|
||||
Before opening up an issue, please search for previous reports.
|
||||
|
||||
New issues are welcome, whether questions or suggestions or reporting bugs.
|
||||
You are also welcome to contribute by adding helpful comments on an existing issue.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
If you want to contribute to code and/or docs, please fork this repo.
|
||||
Pull Requests will be considered. Please open an issue to discuss your idea before requesting big changes.
|
||||
|
||||
If your PR solves an issue, please provide issue number in your commit or in your PR notes.
|
||||
Please submit pull requests against the `develop` branch. The template will prompt you for the details,
|
||||
such as what problem you are solving, and relevant issue numbers.
|
||||
|
||||
_e.g. Avoid exception when version missing. Solves issue #435_
|
||||
|
||||
Leave version number unchanged, that is decided when the release is being prepared.
|
||||
Don't change the version number or CHANGELOG, as they are updated by maintainers as the release is being prepared.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
|
38
.github/ISSUE_TEMPLATE.md
vendored
38
.github/ISSUE_TEMPLATE.md
vendored
@ -1,38 +0,0 @@
|
||||
# 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)
|
58
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
58
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,58 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Found a bug?
|
||||
|
||||
---
|
||||
|
||||
# Bug Report
|
||||
|
||||
<!--
|
||||
The text in these markdown comments is instructions that will not appear in the displayed issue.
|
||||
-->
|
||||
|
||||
## Summary
|
||||
|
||||
<!--
|
||||
Add a clear and concise description of the bug.
|
||||
-->
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
<!--
|
||||
Add precise steps to reproduce the bug.
|
||||
-->
|
||||
|
||||
## Expected Behaviour
|
||||
|
||||
<!--
|
||||
Add a description of what you expected to happen.
|
||||
-->
|
||||
|
||||
## Actual Behaviour
|
||||
|
||||
<!--
|
||||
Add a description of what actually happened.
|
||||
-->
|
||||
|
||||
## Other Information
|
||||
|
||||
<!--
|
||||
Optionally add any other useful information or commentary.
|
||||
-->
|
||||
|
||||
## Configuration Details
|
||||
|
||||
<!--
|
||||
Run these commands and copy in the info.
|
||||
-->
|
||||
|
||||
```bash
|
||||
$ n --version
|
||||
?
|
||||
|
||||
$ command -v node
|
||||
?
|
||||
|
||||
$ node -p process.platform
|
||||
?
|
||||
```
|
24
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
24
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
--
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
|
||||
---
|
||||
|
||||
# Feature Request
|
||||
|
||||
<!--
|
||||
The text in these markdown comments is instructions that will not appear in the displayed issue.
|
||||
This is a suggested template, but you don't have to follow it!
|
||||
-->
|
||||
|
||||
## Problem
|
||||
|
||||
<!--
|
||||
A clear and concise description of what the problem is. e.g. I'm always frustrated when [...]
|
||||
-->
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
<!--
|
||||
A description of what you want to happen.
|
||||
-->
|
44
.github/ISSUE_TEMPLATE/issue-template.md
vendored
44
.github/ISSUE_TEMPLATE/issue-template.md
vendored
@ -1,44 +0,0 @@
|
||||
---
|
||||
name: Issue Template
|
||||
about: Got a problem?
|
||||
|
||||
---
|
||||
|
||||
# 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 latest 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)
|
41
.github/ISSUE_TEMPLATE/support.md
vendored
Normal file
41
.github/ISSUE_TEMPLATE/support.md
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
name: Support
|
||||
about: Got a problem?
|
||||
|
||||
---
|
||||
|
||||
# Problem
|
||||
|
||||
<!--
|
||||
The text in these markdown comments is instructions that will not appear in the displayed issue.
|
||||
This is a suggested template, but you don't have to follow it!
|
||||
-->
|
||||
|
||||
## Short Version
|
||||
|
||||
<!--
|
||||
Add a clear and concise description of your problem.
|
||||
-->
|
||||
|
||||
## Long Version
|
||||
|
||||
<!--
|
||||
Add more explanation and useful information or commentary as needed.
|
||||
-->
|
||||
|
||||
## Configuration Details
|
||||
|
||||
<!--
|
||||
Run these commands and copy in the info.
|
||||
-->
|
||||
|
||||
```bash
|
||||
$ n --version
|
||||
?
|
||||
|
||||
$ command -v node
|
||||
?
|
||||
|
||||
$ node -p process.platform
|
||||
?
|
||||
```
|
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,25 +1,25 @@
|
||||
# Pull Request Template:
|
||||
# Pull Request
|
||||
|
||||
### Describe what you did
|
||||
_i.e. bumped version number up in bin/n_
|
||||
<!--
|
||||
The text in these markdown comments is instructions that will not appear in the displayed pull request.
|
||||
-->
|
||||
|
||||
### How you did it
|
||||
## Problem
|
||||
|
||||
_i.e. bumped version number up in bin/n_
|
||||
<!--
|
||||
What problem are you solving? Include issue numbers if it has been reported.
|
||||
Show the broken output if appropriate.
|
||||
-->
|
||||
|
||||
### How to verify it doesn't effect the functionality of n
|
||||
## Solution
|
||||
|
||||
_i.e. n --version output: 2.1.4_
|
||||
<!--
|
||||
How did you solve the problem?
|
||||
Show the fixed output if appropriate.
|
||||
-->
|
||||
|
||||
### If this solves an issue, please put issue in PR notes.
|
||||
## ChangeLog
|
||||
|
||||
_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
|
||||
<!--
|
||||
Optional. Suggest a line for adding to the CHANGELOG to summarise your change.
|
||||
-->
|
||||
|
@ -18,7 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
||||
|
||||
### Changed
|
||||
|
||||
- reinstalling active node version does reinstall (previously silently did nothing)
|
||||
- reinstalling active node version always does reinstall (previously silently did nothing)
|
||||
- log message for installing using menu now same format as `npm install` message
|
||||
- updates to GitHub templates and guidelines for contributing et al
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user