From ec70fa8f43276af9bfc8d79542398013054a5bca Mon Sep 17 00:00:00 2001
From: Vedran Kasalica <v.kasalica@esciencecenter.nl>
Date: Wed, 25 Sep 2024 11:50:30 +0200
Subject: [PATCH] Simplify PR and issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 30 +++++-------
 .github/ISSUE_TEMPLATE/feature_request.md | 27 +----------
 .github/pull_request_template.md          | 56 ++++-------------------
 3 files changed, 24 insertions(+), 89 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index f1e4a73..462725a 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,13 +1,16 @@
 ---
-name: Bug Report
-about: Create a report to help improve the APE library
-title: '[BUG] '
-labels: 'bug'
-assignees: vedran-kasalica
+name: Bug report
+about: Create a report to help us improve the APE library
+title: ''
+labels: bug
+assignees: ''
 
 ---
 
-**Note:** Not all fields are obligatory, but the more details you provide, the easier it will be for us to address the issue. Feel free to omit sections that you feel are not relevant to your report.
+## Checklist before submitting a bug report
+
+- [ ] I have checked the [existing issues](https://github.com/NLeSC/python-template/issues) and couldn't find an issue about this bug.
+
 
 ## Description
 <!-- Provide a clear and concise description of what the bug is. -->
@@ -16,12 +19,10 @@ assignees: vedran-kasalica
 <!-- Indicate whether this issue is related to the API or the CLI. -->
 - [ ] API
 - [ ] CLI
+- [ ] REST API
 
-## APE Version
-<!-- Specify the version of APE you're using. -->
-
-## Java Version
-<!-- Specify the Java version you're using. -->
+## APE and Java Version
+<!-- Specify the version of APE and Java you're using. -->
 
 ## Steps to Reproduce
 <!-- Provide detailed steps to reproduce the bug: -->
@@ -30,14 +31,7 @@ assignees: vedran-kasalica
 3. 
 4. 
 
-## Expected Behavior
-<!-- Describe what you expected to happen. -->
-
-## Actual Behavior
-<!-- Describe what actually happened. Include complete error messages, screenshots, or logs if possible. -->
 
-## Possible Solution
-<!-- Suggest a fix/reason for the bug, if you have one in mind. -->
 
 ## Additional Context
 <!-- Add any other context about the problem here, such as special configurations, environment details, etc. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 66998a7..3a2c469 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,34 +1,11 @@
 ---
 name: Feature Request
 about: Suggest a new feature or enhancement for the APE library
-title: '[FEATURE] '
+title: ''
 labels: 'enhancement'
-assignees: vedran-kasalica
+assignees: ''
 
 ---
 
-**Note:** Not all fields are obligatory, but the more details you provide, the easier it will be for us to address the issue. Feel free to omit sections that you feel are not relevant to your report.
-
 ## Feature Description
 <!-- Provide a clear and concise description of the feature or enhancement you're proposing. -->
-
-## Is this feature 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 detailed 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. -->
-
-## API/CLI Impact
-<!-- Indicate whether this feature is related to the API, CLI, or both. -->
-- [ ] API
-- [ ] CLI
-- [ ] Both
-
-## Potential Benefits
-<!-- Describe the potential benefits this feature would bring to APE library users, such as increased efficiency, new capabilities, or compatibility improvements. -->
-
-## Additional Context
-<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index f5cf5b3..0056eb6 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,54 +1,18 @@
----
-name: Pull Request
-about: Submit a pull request to contribute to the APE library
-title: ''
-labels: ''
-assignees: vedran-kasalica
-
----
-
-**Note:** Not all fields are obligatory, but the more details you provide, the easier it will be for us to address the issue. Feel free to omit sections that you feel are not relevant to your report.
-
 ## Pull Request Overview
-<!-- Provide a brief overview of what this PR aims to accomplish. For instance, this could be a bug fix, feature addition, documentation update, etc. -->
+<!-- Briefly describe what this PR does (e.g., bug fix, feature addition, etc.). -->
 
-## Related Issue(s) or Pull Request(s)
-<!-- Mention any related issues or previous PRs that this PR is related to or dependent on. Use the format `#issue_number` or `#PR_number` to automatically link them. -->
+## Related Issue
+<!-- Link the related issue using the format `#issue_number`. -->
 
 ## Changes Introduced
-<!-- Provide a detailed list of the changes introduced in this PR. Break down new features, bug fixes, enhancements, and API or CLI modifications. -->
-
-## Motivation and Context
-<!-- Explain the background for making these changes. What is the current problem you’re solving, or what new functionality are you adding? -->
+<!-- List the key changes made in this PR. -->
 
 ## How Has This Been Tested?
-<!-- Describe in detail how you tested your changes. Include details of your testing environment, tests ran, and any other relevant information. If applicable, include steps to reproduce the issue this PR addresses. -->
-
-## API/CLI Changes
-<!-- Specify any changes to the API or CLI interface. Include a brief description of the change and how developers should adapt their usage of the library or CLI. -->
-
-## Screenshots (if appropriate):
-<!-- Include any relevant screenshots or gifs to visually illustrate the changes made in this PR. -->
-
-## Potential Impacts
-<!-- Discuss any potential impacts or side effects of this PR. This includes implications for users, dependencies, or other parts of the system. -->
-
-## Checklist:
-<!-- Before submitting this PR, please go through the following checklist and check all the boxes that apply. -->
-- [ ] I have followed the [style guidelines](https://github.com/sanctuuary/APE/blob/main/CONTRIBUTION.md#good-java-practices) of this project.
-- [ ] I have performed a self-review of my own code.
-- [ ] I have commented my code, particularly in hard-to-understand areas.
-- [ ] I have made corresponding changes to the documentation (if applicable).
-- [ ] My changes generate no new warnings.
-- [ ] I have added tests that prove my fix is effective or that my feature works.
-- [ ] New and existing unit tests pass locally with my changes.
+<!-- Briefly describe how you tested your changes. -->
 
-## Additional Notes
-<!-- Any additional information that you believe is important to the review. -->
+## Checklist
 
-## Reviewer Checklist:
-<!-- Before approving this PR, please go through the following checklist and check all the boxes that apply. -->
-- [ ] The code follows the project’s style guide.
-- [ ] The changes are well-documented and commented.
-- [ ] The tests cover all changes adequately.
-- [ ] All checks pass successfully.
+- [ ] I have referenced a related issue.
+- [ ] I have followed the project’s style guidelines.
+- [ ] My changes include tests, if applicable.
+- [ ] All tests pass locally.