This is an automated email from the ASF dual-hosted git repository. rec pushed a commit to branch feature/152-Provide-template-files-for-GitHub-issues-and-PRs in repository https://gitbox.apache.org/repos/asf/incubator-annotator.git
commit 30268c16afcaa3139dbb422002f9da68c4a712e2 Author: Richard Eckart de Castilho <[email protected]> AuthorDate: Tue Oct 3 14:58:43 2023 +0200 Issue #152: Provide template files for GitHub issues and PRs - Copied templates from Apache UIMA and adapted them to Apache Annotator --- .github/ISSUE_TEMPLATE/bug_report.md | 28 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++++++++++++ .github/ISSUE_TEMPLATE/refactoring.md | 10 ++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 5 files changed, 74 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..7b6411f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..28a266d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Apache Annotator Forum/Mailing list + url: https://lists.apache.org/[email protected] + about: Community support. 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 new file mode 100644 index 0000000..f436f61 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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>
