From e81edac2e496c24f47ebb5960379fd7964b2a6c2 Mon Sep 17 00:00:00 2001 From: John Gee Date: Sun, 2 Jun 2019 20:55:21 +1200 Subject: [PATCH] Rework and add github templates --- .github/CONTRIBUTING.md | 12 +++-- .github/ISSUE_TEMPLATE.md | 38 --------------- .github/ISSUE_TEMPLATE/bug_report.md | 58 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++ .github/ISSUE_TEMPLATE/issue-template.md | 44 ----------------- .github/ISSUE_TEMPLATE/support.md | 41 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 36 +++++++------- CHANGELOG.md | 2 +- 8 files changed, 149 insertions(+), 106 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/issue-template.md create mode 100644 .github/ISSUE_TEMPLATE/support.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4712390..2516f36 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index d6b09ff..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -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) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..58dda32 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,58 @@ +--- +name: Bug Report +about: Found a bug? + +--- + +# Bug Report + + + +## Summary + + + +## Steps to Reproduce + + + +## Expected Behaviour + + + +## Actual Behaviour + + + +## Other Information + + + +## Configuration Details + + + +```bash +$ n --version +? + +$ command -v node +? + +$ node -p process.platform +? +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..92250a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +-- +name: Feature request +about: Suggest an idea for this project + +--- + +# Feature Request + + + +## Problem + + + +## Proposed Solution + + diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md deleted file mode 100644 index 666f4b1..0000000 --- a/.github/ISSUE_TEMPLATE/issue-template.md +++ /dev/null @@ -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) diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md new file mode 100644 index 0000000..b40e888 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support.md @@ -0,0 +1,41 @@ +--- +name: Support +about: Got a problem? + +--- + +# Problem + + + +## Short Version + + + +## Long Version + + + +## Configuration Details + + + +```bash +$ n --version +? + +$ command -v node +? + +$ node -p process.platform +? +``` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 24923b6..eecff11 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,25 +1,25 @@ -# Pull Request Template: +# Pull Request -### Describe what you did - _i.e. bumped version number up in bin/n_ + -### How you did it +## Problem -_i.e. bumped version number up in bin/n_ + -### How to verify it doesn't effect the functionality of n +## Solution -_i.e. n --version output: 2.1.4_ + -### 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 + diff --git a/CHANGELOG.md b/CHANGELOG.md index 6042b20..c1e178a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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