Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Commit

Permalink
Added PR template for bug fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
woojiahao committed Apr 6, 2019
1 parent 86e689b commit 3120267
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@ is someone else doing this issue, you could request for a collaboration or pick
If you are a beginner, pick the issues with the label `good-first-issue` and try to solve it, you can always request
for assistance if you encounter any roadblocks along the way.

## Making a pull request
## Pull requests
If you wish to make a PR, fork the repository, create a remote branch that the PR is meant to address, and make a PR
to the `development` branch on the main repository.

If your PR is meant to fix an issue, please reference the issue in the title of the remote branch like `issue-51-fix`.

There are several PR templates that are loaded for this repository, find the one that fits your requirements and use it.

## Making a good issue
There is no strict format for making issues, however, the following points are parts to include when making an issue.

Expand Down
31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix_pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug fix pull request
about: Create a pull request for a bug fix
title: "[BUG FIX]"

---

**Describe the bug**
A clear and concise description of what the bug is.

Reference an existing issue if present.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.

**Requirements**
1. CI must pass
2. Unit tests must be written to test that the fix works repeatably

0 comments on commit 3120267

Please sign in to comment.