From adbcca6c5201c4802be4a1630f157439ec2abef3 Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Sat, 6 Jan 2018 18:06:58 -0500 Subject: [PATCH] docs: add issue template --- .github/ISSUE_TEMPLATE.md | 48 ++++++++++++++++++++++ .github/ISSUE_TEMPLATES/bug-report.md | 17 ++++++++ .github/ISSUE_TEMPLATES/feature-request.md | 13 ++++++ .github/ISSUE_TEMPLATES/plugin-request.md | 9 ++++ CONTRIBUTING.md | 45 +++++++++++--------- 5 files changed, 112 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATES/bug-report.md create mode 100644 .github/ISSUE_TEMPLATES/feature-request.md create mode 100644 .github/ISSUE_TEMPLATES/plugin-request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..ad17f62e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,48 @@ + + + + +## Current behavior + + + +## Expected behavior + + + +## Environment + +- **semantic-release** version: +- CI environment: +- Plugins used: +- **semantic-release** configuration: +- CI logs: + + + +## New feature motivation + + + +## New feature description + + + +## New feature implementation + + + + + +## New plugin motivation + + + +## Third-party documentation + + diff --git a/.github/ISSUE_TEMPLATES/bug-report.md b/.github/ISSUE_TEMPLATES/bug-report.md new file mode 100644 index 00000000..0beea594 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/bug-report.md @@ -0,0 +1,17 @@ +# Bug report + +## Current behavior + + + +## Expected behavior + + + +## Environment + +- **semantic-release** version: +- CI environment: +- Plugins used: +- **semantic-release** configuration: +- CI logs: diff --git a/.github/ISSUE_TEMPLATES/feature-request.md b/.github/ISSUE_TEMPLATES/feature-request.md new file mode 100644 index 00000000..416da97e --- /dev/null +++ b/.github/ISSUE_TEMPLATES/feature-request.md @@ -0,0 +1,13 @@ +# Feature request + +## New feature motivation + + + +## New feature description + + + +## New feature implementation + + diff --git a/.github/ISSUE_TEMPLATES/plugin-request.md b/.github/ISSUE_TEMPLATES/plugin-request.md new file mode 100644 index 00000000..db4da3c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/plugin-request.md @@ -0,0 +1,9 @@ +# New plugin request + +## New plugin motivation + + + +## Third-party documentation + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5610a812..2ffae980 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,9 +21,7 @@ Help us keep **semantic-release** open and inclusive. Please read and follow our ### Improve documentation -As a **semantic-release** user you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes/README.md) etc. - -Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+). +As a **semantic-release** user you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes/README.md) etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+). Please follow the [Documentation guideline](#documentation). @@ -31,33 +29,39 @@ Please follow the [Documentation guideline](#documentation). Some issues are created without information requested in the [Bug report guideline](#bug-report). Help making them easier to resolve by adding any relevant informations. -The issue [Design issue](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**. +Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**. ### Fix bugs and implement features -Confirmed bug reports and ready to implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22). Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community. +Confirmed bug and ready to implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22). Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community. ## Using the issue tracker The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions. -Before opening an Issue or a Pull Request, please the use the [GitHub issue search](https://github.com/issues?utf8=%E2%9C%93&q=user%3Asemantic-release) to make the issue or feature request hasn't been already reported or fixed. +Before opening an Issue or a Pull Request, please use the [GitHub issue search](https://github.com/issues?utf8=%E2%9C%93&q=user%3Asemantic-release) to make the bug or feature request hasn't been already reported or fixed. ### Bug report -A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report and fill the information request in the Issue Template. +A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report and fill the information requested in the [Bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=bug-report.md). ### Feature request -Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible. +Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the [Feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=feature-request.md). + +### New plugin request + +[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type. Please provide as much detail and context as possible and fill the information requested in the [New plugin request template](https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md). ## Submitting a Pull Request -Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. +Good pull requests whether patches, improvements or new features are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. **Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. -If you never created a pull request before, welcome 🎉 😄 [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :) +If you never created a pull request before, welcome 🎉 😄. [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :) + +Here is a summary of the steps to follow: 1. [Set up the workspace](#set-up-the-workspace) 2. If you cloned a while ago, get the latest changes from upstream and update dependencies: @@ -80,18 +84,19 @@ $ git push origin **Tips**: - For ambitious tasks, open a Pull Request as soon as possible with the `[WIP]` prefix i nthe title, in order to get feedback and help from the community. +- [Allow semantic-release maintainers to make changes to you Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) this way we can rebase it and make some minor changes if necessary. All changes we make will be done in new commit and we'll ask for your approval before merging them. ## Coding rules ### Source code -To ensure consistency and quality throughout the source code, all code modification must: -- Have no [linting](#lint) errors -- Make sure there is a [test](#tests) for every possible cases introduced by your code change -- The test coverage is **100%** -- The commit message(s) follow the [guideline](#commit-message-guidelines) -- Documentation is added for new features -- Documentation is updated for modified features +To ensure consistency and quality throughout the source code, all code modification must have: +- No [linting](#lint) errors +- A [test](#tests) for every possible cases introduced by your code change +- **100%** test coverage +- [Valid commit message(s)](#commit-message-guidelines) +- Documentation for new features +- Updated documentation for modified features ### Documentation @@ -206,9 +211,9 @@ $ npm install ### Lint -All the [semantic-release](https://github.com/semantic-release) repository use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting. Prettier formatting will be automatically verified adn fixed by XO. +All the [semantic-release](https://github.com/semantic-release) repository use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting. Prettier formatting will be automatically verified and fixed by XO. -Before pushing your code changes make sure there is no linting errors by with `npm run lint`. +Before pushing your code changes make sure there is no linting errors with `npm run lint`. **Tips**: - Most linting errors can be automatically fixed with `npm run lint --fix`. @@ -216,7 +221,7 @@ Before pushing your code changes make sure there is no linting errors by with `n ### Tests -Running the integration require to install [Docker](https://docs.docker.com/engine/installation) on your machine. +Running the integration test require to install [Docker](https://docs.docker.com/engine/installation) on your machine. All the [semantic-release](https://github.com/semantic-release) repository use [AVA](https://github.com/avajs/ava) for writing and running tests.