From 4b118bb47cedcd3d9a3af99af2b4dcef0c28cbc8 Mon Sep 17 00:00:00 2001 From: Richard Eckart de Castilho Date: Mon, 22 Jul 2024 14:05:36 -0300 Subject: [PATCH] No issue: Added issue templates --- .github/CONTRIBUTING.md | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++++++ .github/ISSUE_TEMPLATE/refactoring.md | 11 +++++++++ .github/pull_request_template.md | 11 +++++++++ 6 files changed, 76 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/refactoring.md create mode 100644 .github/pull_request_template.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..3afea41 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1 @@ +See the [DKPro Contribution Guidelines](https://dkpro.github.io/contributing). diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..04f2971 --- /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 and build ID: [see bottom of the browser screen] + - 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..d71125c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: INCEpTION Forum/Mailing list + url: https://groups.google.com/d/forum/inception-users + about: Community support. + - name: INCEpTION Gitter/Matrix Channel + url: https://gitter.im/inception-project/Lobby + 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..066b2d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +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..3abda76 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactoring.md @@ -0,0 +1,11 @@ +--- +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..920a0ea --- /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