Skip to content

Commit

Permalink
Issue #152: Provide template files for GitHub issues and PRs
Browse files Browse the repository at this point in the history
- Copied templates from Apache UIMA and adapted them to Apache Annotator
  • Loading branch information
reckart committed Oct 3, 2023
1 parent 4373cf2 commit 30268c1
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug report
about: Create a report to help us improve
---

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

**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.

**Please complete the following information:**
- Version: [e.g. 0.2.0]
- Browser: [e.g. Chrome v123, Firefox v113]
- OS: [e.g. Windows 11, Ubuntu Linux 23.4, macOS 13]

**Additional context**
Add any other context about the problem here.
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: Apache Annotator Forum/Mailing list
url: https://lists.apache.org/list.html?dev@annotator.apache.org
about: Community support.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature request
about: Suggest an idea for this project
---

**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.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/refactoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Refactoring (for developers)
about: Refactor the application
---

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

**Expected benefit**
A clear and concise description of what you expect to improve by the refactoring.
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**What's in the PR**
* ...

**How to test manually**
* ...

**Automatic testing**
* [ ] PR adds/updates unit tests

**Documentation**
* [ ] PR adds/updates documentation

**Organizational**
- [ ] PR adds/updates dependencies.
<sub><sup>Only dependencies under [approved licenses](http://www.apache.org/legal/resolved.html#category-a) are allowed. LICENSE and NOTICE files in the respective modules where dependencies have been added as well as in the project root have been updated.</sup></sub>

0 comments on commit 30268c1

Please sign in to comment.