-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the GitHub pull request template
- Loading branch information
1 parent
33fd1da
commit 6288988
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- Click on the "Preview" tab to render the instructions in a more readable format --> | ||
|
||
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/icecore-hashids/blob/develop/CONTRIBUTING.md) before filling out this pull request template**. | ||
## Prerequisites | ||
|
||
This section and the instructions in the sections below are only part of this pull request template. Please ensure to **delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting** to ensure a clear structure and overview. | ||
|
||
Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug fix to help maintainers and the community understand and reproduce the behavior, find related pull requests and to merge it faster. | ||
|
||
* **Ensure the pull request has not already been reported by using the [GitHub Pull Request search](https://github.com/arcticicestudio/icecore-hashids/pulls)** — if it has **and the pull request is still open**, add a comment to the existing pull request instead of opening this new one. If you find a closed pull request that seems to be similar to this one, include a link to it in the [metadata head](#metadata-head) section of this pull request. | ||
* **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/icecore-hashids/blob/feature/gh-12-github-open-source-community-standards/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations. | ||
|
||
## Metadata Head | ||
|
||
The metadata head should be added to the top of the pull request as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the [GitHub issue keywords][gh-help-issue-keywords] to link to the related enhancements suggestions (`Closes`) or bug reports (`Fixes`). You can add additional details like dependencies to other pull requests and the order it needs to be merged. | ||
|
||
> Closes ISSUE_ID | ||
Must be merged **after**/**before** ISSUE_ID | ||
|
||
## Description | ||
|
||
Describe the changes as in many relevant details as possible. If this is a enhancement suggestion add specific use-cases and explain why this feature or improvement would be useful. If this is a bug fix ensure to provide a *before/after* comparison by describing the current behavior and the new behavior. | ||
|
||
## References | ||
|
||
Add any other references and links which are relevant for this issue. |