Skip to content

Commit

Permalink
add templates for issues and PRs (#3)
Browse files Browse the repository at this point in the history
resolve #2
  • Loading branch information
thomas-fossati authored Nov 4, 2020
1 parent 6df8853 commit a4f534d
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
title: 'BUG: '
about: Help us improve
labels: 'bug'
assignees: ''
---

### What version of the package are you using?


### Does this issue reproduce with the latest release?


### What OS and CPU architecture are you using (`go env`)?


### What did you do?

<!--
If possible, provide steps and/or code to reproduce the problem
-->

### What did you expect to see?


### What did you see instead?
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Veraison Zulip streams
url: https://invalid.example
about: Please ask and answer questions here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/docs-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Docs issue
title: 'DOCS: '
about: Report an issue regarding documentation
labels: 'documentation'
assignees: ''

---

### Please describe the problem
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: "\U0001F4A1 Feature request"
about: Suggest an idea for this project
title: 'feature: '
labels: 'enhancement'
assignees: ''
---

### Is your feature request related to a problem? Please describe

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### If possible, describe a solution

A clear and concise description of what you want to happen.

### Describe alternatives you have considered

A clear and concise description of any alternative solutions or features you've considered.

## Additional context

Add any other context or screenshots about the feature request here.
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### Description
<!--
Please explain the changes you made here.
Add a reference to a related issue in the repository.
@mentions of the person or team responsible for reviewing proposed changes.
-->

### Checklist
- [ ] Code compiles correctly
- [ ] Created tests which fail without the change (if possible)
- [ ] All tests passing
- [ ] Extended the README / documentation, if necessary

0 comments on commit a4f534d

Please sign in to comment.