Skip to content

Commit

Permalink
docs: add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdlg committed Jan 7, 2018
1 parent e0b4e6a commit adbcca6
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 20 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,48 @@
<!--
Please fill the informations requested or use one of the following url:
- Bug report: https://github.com/semantic-release/semantic-release/issues/new?template=bug-report.md
- Feature request: https://github.com/semantic-release/semantic-release/issues/new?template=feature-request.md
- New plugin request: https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md
-->

<!--------------------- FOR BUG REPORT ONLY --------------------->

## Current behavior

<!-- Describe how the issue manifests. -->

## Expected behavior

<!-- Describe what the desired behavior would be. -->

## Environment

- **semantic-release** version: <!-- Version set in package.json devDpendencies -->
- CI environment: <!-- CI service name -->
- Plugins used: <!-- List semantic-release plugin used if any -->
- **semantic-release** configuration: <!-- link to your repository or relevant part of the semantic-release config -->
- CI logs: <!-- link to your CI logs or semantic-release logs -->

<!--------------------- FOR FEATURE REQUEST ONLY --------------------->

## New feature motivation

<!-- Describe the context, the use-case and the advantages of the feature request. -->

## New feature description

<!-- Describe the functional changes that would have to be made in semantic-release or its plugins. -->

## New feature implementation

<!-- Optionally describe the technical changes to be made in semantic-release or its plugins. -->

<!--------------------- FOR NEW PLUGIN REQUEST ONLY --------------------->

## New plugin motivation

<!-- Describe the reasons to create a new plugin and why it's not covered by the existing ones. -->

## Third-party documentation

<!-- Provide explanation and documentation links for the platform to integrate with. -->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATES/bug-report.md
@@ -0,0 +1,17 @@
# Bug report

## Current behavior

<!-- Describe how the issue manifests. -->

## Expected behavior

<!-- Describe what the desired behavior would be. -->

## Environment

- **semantic-release** version: <!-- Version set in package.json devDpendencies -->
- CI environment: <!-- CI service name -->
- Plugins used: <!-- List semantic-release plugin used if any -->
- **semantic-release** configuration: <!-- link to your repository or relevant part of the semantic-release config -->
- CI logs: <!-- link to your CI logs or semantic-release logs -->
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATES/feature-request.md
@@ -0,0 +1,13 @@
# Feature request

## New feature motivation

<!-- Describe the context, the use-case and the advantages of the feature request. -->

## New feature description

<!-- Describe the functional changes that would have to be made in semantic-release or its plugins. -->

## New feature implementation

<!-- Optionally describe the technical changes to be made in semantic-release or its plugins. -->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATES/plugin-request.md
@@ -0,0 +1,9 @@
# New plugin request

## New plugin motivation

<!-- Describe the reasons to create a new plugin and why it's not covered by the existing ones. -->

## Third-party documentation

<!-- Provide explanation and documentation links for the platform to integrate with. -->
45 changes: 25 additions & 20 deletions CONTRIBUTING.md
Expand Up @@ -21,43 +21,47 @@ 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).

### Give feedback on issues

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:
Expand All @@ -80,18 +84,19 @@ $ git push origin <topic-branch-name>

**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

Expand Down Expand Up @@ -206,17 +211,17 @@ $ 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`.
- Install the [XO plugin](https://github.com/sindresorhus/xo#editor-plugins) for your editor to see linting error directly in your editor and automatically fix them on save.

### 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.

Expand Down

0 comments on commit adbcca6

Please sign in to comment.