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-uimafit.git
commit ace24da497b1877d89ac032d99e458b689005d5b Author: Richard Eckart de Castilho <[email protected]> AuthorDate: Mon Apr 25 11:21:07 2022 +0200 [UIMA-6433] Update issue and PR templates - Simplified 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 | 39 +++++++------------------------ 5 files changed, 69 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..d1dd9df --- /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 0000000..8a83dd3 --- /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/[email protected] + 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 0000000..a09db44 --- /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 0000000..10ad472 --- /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 index 4610c13..920a0ea 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,34 +1,11 @@ -<!-- -Thank you for contributing to Apache UIMA uimaFIT. +**What's in the PR** +* ... -In order to streamline the review of the contribution we ask you -to ensure the following steps have been taken: ---> +**How to test manually** +* ... -**JIRA Ticket:** https://issues.apache.org/jira/browse/UIMA-XXXX +**Automatic testing** +* [ ] PR includes unit tests -### For all changes: -- [ ] PR title starts with `[UIMA-XXXX]`. -- [ ] Commit messages conform to the following format -``` -[UIMA-<ISSUE-NUMBER>] <ISSUE TITLE> -<EMPTY LINE> -- <CHANGE 1> -- <CHANGE 2> -- ... -``` - -### For code changes: -- [ ] PR includes new or updated tests related to the contribution. -- [ ] PR includes new dependencies. 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. - -### For documentation related changes: -- [ ] PDF and HTML versions of the documentation render ok. - -<!-- -### Note: -Please ensure that once the PR is submitted, you check the Jenkins build status listed under -"Checks" in the PR for issues and submit an update to your PR as soon as possible. ---> \ No newline at end of file +**Documentation** +* [ ] PR updates documentation
