You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2022/04/25 10:34:52 UTC

[uima-uimaj] 01/01: [UIMA-6433] Update issue and PR templates

This is an automated email from the ASF dual-hosted git repository.

rec pushed a commit to branch refactoring/UIMA-6433-Update-issue-and-PR-templates
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git

commit a03d0663d4cb48479e5cc9e307b710ff11ce4e4b
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Mon Apr 25 12:34:45 2022 +0200

    [UIMA-6433] Update issue and PR templates
    
    - Added PR template
    - Added tentative issue templates in case we switch from Jira to GitHub Issues
    - Added contact links to the "new issue" page in case we switch from Jira to GitHub Issues
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 27 +++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml         |  8 ++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++++++++++++
 .github/ISSUE_TEMPLATE/refactoring.md     | 10 ++++++++++
 .github/PULL_REQUEST_TEMPLATE.md          | 11 +++++++++++
 5 files changed, 72 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..d1dd9df9b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,27 @@
+---
+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. 3.2.0]
+ - OS: [e.g. Windows, Linux, OS X]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..8a83dd328
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Apache UIMA Forum/Mailing list
+    url: https://lists.apache.org/list.html?user@uima.apache.org
+    about: Community support.
+  - name: Apache UIMA Gitter/Matrix Channel
+    url: https://gitter.im/apache/uima
+    about: Public chat channel.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..a09db44fb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -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.
diff --git a/.github/ISSUE_TEMPLATE/refactoring.md b/.github/ISSUE_TEMPLATE/refactoring.md
new file mode 100644
index 000000000..10ad4722f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/refactoring.md
@@ -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.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..920a0ea1d
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+**What's in the PR**
+* ...
+
+**How to test manually**
+* ...
+
+**Automatic testing**
+* [ ] PR includes unit tests
+
+**Documentation**
+* [ ] PR updates documentation