style(github): Add github issue templates¶
Description¶
Abstract¶
Adds “bug-report” and “feature-request” issue templates in .github/ISSUE_TEMPLATE/ directory.
Motivation¶
If users want to report an issue or propose a feature, we should help them add as much details as possible.
Rationale¶
We used the github generator and slightly modified the content
Info¶
- Hash
5fd48dc17c01e1b8f61dc3b66529fa21f03c488c
- Date
2019-06-05 18:13:47 +0200
- Parents
style(github): Use git commit template as github pull request template [4d56c3e7] — 2019-06-05 17:51:46 +0200
- Children
Merge branch ‘feature/twidi/github-templates’ into develop [878b7ed4] — 2019-06-05 18:19:41 +0200
- Branches
- Tags
(No tags)
Changes¶
.github/ISSUE_TEMPLATE/bug-report.md¶
- Type
Added
- Stats
+46 -0
@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+Describe the bug
+================
+
+A clear and concise description of what the bug is.
+
+To Reproduce
+============
+
+Steps to reproduce the behavior:
+
+1. Go on '...'
+2. Do '....'
+3. Then do '....'
+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.
+
+Device
+======
+
+- Kind: [one of server/desktop/smartphone]
+- OS: [e.g. Ubuntu 18.04, OS X 10.14, Android 8, iOS 13...]
+- Browser: [if applicable: Firefox 65, Chrome 62, Safari 12...]
+- [And any other you may find useful]
+
+Additional context
+==================
+
+Add any other context about the problem here.
.github/ISSUE_TEMPLATE/feature-request.md¶
- Type
Added
- Stats
+28 -0
@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+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 [...]
+
+Describe the solution you'd like
+================================
+
+A clear and concise description of what you want to happen.
+
+Describe alternatives you've 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.