Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added GitHub Issue and PR templates. #3165

Merged
merged 1 commit into from
May 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug Report
about: Give as much information as you can, and be sure to search existing
Issues first.
title: ''
labels: bug
assignees: ''

---

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

**Release version(s) and/or repository branch(es) affected?**
Have you checked that the bug is not already fixed in newer versions?

**Steps to reproduce the bug**
Give sufficient details so that others can quickly verify the problem.

**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 other useful information here.

**Pull requests welcome!**
This is an Open Source project - please consider contributing a bug fix
yourself (please read `CONTRIBUTING.md` before starting any work though).
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature Request
about: Give as much information as you can, and be sure to search existing
Issues first.
title: ''
labels: ''
assignees: ''

---

**Describe exactly what you would like to see in an upcoming release**
Give a clear and concise description of the new feature or behaviour, and
reasons why you think it would be useful.

**Additional context**
Add other useful information here.

**Pull requests welcome!**
This is an Open Source project - please consider contributing code yourself
(please read `CONTRIBUTING.md` before starting any work though).
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
COMMENT: Complete this Pull Request template and delete all "COMMENT:" lines.

COMMENT: Significant PRs should address an existing Issue. Choose one of:
These changes partially address #xxxx
These changes close #xxxx
This is a small change with no associated Issue.

COMMENT: The following requirements must be satisfied, now or before merge.
COMMENT: Mark the PR as a Draft if not all are satisfied just yet.
Requirements check-list:
- [ ] I have read `CONTRIBUTING.md` and added my name as a Code Contributor.
- [ ] My commits have logically grouped changes (use interactive rebase
to tidy your branch history if necessary).
- [ ] I have not included off-topic changes (use other PRs for these).
- [ ] I have included tests with adequate coverage.
- [ ] I have added an entry in `CHANGES.md` for next release.