From 315735f075c33a586ef6a1249e18ba96eef6372c Mon Sep 17 00:00:00 2001
From: sovitybot <107936402+sovitybot@users.noreply.github.com>
Date: Wed, 21 Feb 2024 12:20:05 +0100
Subject: [PATCH] Templates: synced file(s) with sovity/PMO-Software (#755)

---
 .github/ISSUE_TEMPLATE/bug_report.md          | 26 +++++-----
 .github/ISSUE_TEMPLATE/documentation.md       | 30 ++++++++++++
 .github/ISSUE_TEMPLATE/epic_template.md       | 41 ++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md     | 32 +++++--------
 .github/ISSUE_TEMPLATE/process.md             | 24 ++++++++++
 .github/PULL_REQUEST_TEMPLATE.md              | 47 +++++++++++++++----
 .../workflows/add_pullrequest_to_project.yml  |  1 +
 7 files changed, 160 insertions(+), 41 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/documentation.md
 create mode 100644 .github/ISSUE_TEMPLATE/epic_template.md
 create mode 100644 .github/ISSUE_TEMPLATE/process.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 0b6ebc34e..55705dfff 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,37 +2,33 @@
 name: Bug Report
 about: Create a report to help us improve
 title: ""
-labels: ["kind/bug", "task/analyze", "scope/ce"]
+labels: "kind/bug"
 assignees: ""
 ---
 
 # Bug Report
 
 ## Description
-
-_A clear and concise description of the bug._
-_If applicable, add screenshots or other information to help explain your problem._
+<!-- A clear and concise description of the bug. -->
+<!-- If applicable, add screenshots or other information to help explain your problem. -->
 
 ### Expected Behavior
-
-_A clear and concise description of what you expected to happen._
+<!-- A clear and concise description of what you expected to happen. -->
 
 ### Observed Behavior
-
-_A clear and concise description of what happened instead._
+<!-- A clear and concise description of what happened instead. -->
 
 ## Steps to Reproduce
-
-Steps to reproduce the behavior:
+<!-- Steps to reproduce the behavior:
 
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
+-->
 
 ## Context Information
-
-_Add any other context about the problem here._
+<!-- Add any other context about the problem here.
 
 -   Environment: Which instance or deployment were you using when the error occurred? Staging, Productive, Connector-URL, etc.?
 -   Used version: If a specific component was used, which Version did you use? E.g. EDC v1.0.0
@@ -41,10 +37,12 @@ _Add any other context about the problem here._
 -   Parameter: Request contents or information entered
 -   OS: [e.g. iOS, Windows]
 -   ...
+-->
 
 ## Possible Implementation and Work Breakdown
+<!-- You already know the root cause of the erroneous state and how to fix it? Feel free to share your thoughts and edit the tasklist. -->
 
 ```[tasklist]
-- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
-- [ ] Refine a Solution Proposal / Work Breakdown
+- [ ] adjust the labels, sprint and other metadata
+- [ ] refine a solution proposal / work breakdown
 ```
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 000000000..4ca8c166d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,30 @@
+---
+name: Documentation Update Request
+about: Create a report to help us improve our documentation
+title: ""
+labels: "task/documentation"
+assignees: ""
+---
+
+# Documentation Update Request
+
+## Description
+<!-- Provide a brief overview of the documentation update request. What section or topic needs to be updated? -->
+
+## Current Documentation
+<!--- Insert a link to the current documentation related to the topic. -->
+
+## Proposed Changes
+<!-- Describe the changes that need to be made. Be as specific as possible. -->
+
+## Justification
+<!-- Explain why these changes are necessary. Is there new information, outdated content, or improvements needed for clarity? -->
+
+## Additional Context
+<!-- Include any additional context, screenshots, examples, or references that might help in understanding the update request. -->
+
+## Deadline
+<!-- Set a deadline for completing the documentation update, if applicable. -->
+
+## Notes
+<!-- Any additional notes or instructions for the team regarding this documentation update request. -->
diff --git a/.github/ISSUE_TEMPLATE/epic_template.md b/.github/ISSUE_TEMPLATE/epic_template.md
new file mode 100644
index 000000000..24edb0b59
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/epic_template.md
@@ -0,0 +1,41 @@
+---
+name: Epic
+about: Help us with new ideas
+title: ""
+labels: "kind/epic"
+assignees: ""
+---
+
+# Epic
+
+## Description
+<!-- Brief summary of what this Epic is, whether it's a larger project, goal, or user story. Describe the job to be done, which persona this Epic is mainly for, or if more multiple, break it down by user and job story. -->
+
+### Requirements
+<!-- Which requirements do you have to be fulfilled? -->
+
+## Work Breakdown
+<!-- If you already know what needs to be done, plase add a tasklist. -->
+
+```[tasklist]
+### Stories
+- [ ] Create Stories which can be converted into issues
+```
+
+## Initiative / goal
+<!-- Describe how this Epic impacts an initiative the business is working on. -->
+
+### Hypothesis
+<!-- What is your hypothesis on the success of this Epic? Describe how success will be measured and what leading indicators the team will have to know if success has been hit. -->
+
+## Acceptance criteria and must have scope
+<!-- Define what is a must-have for launch and in-scope. Keep this section fluid and dynamic until you lock-in priority during planning. Please list your criteria below. -->
+
+## Stakeholders
+<!-- Describe who needs to be kept up-to-date about this Epic, included in discussions, or updated along the way. Stakeholders can be both in Product/Engineering, as well as other teams like Customer Success who might want to keep customers updated on the epic project. -->
+
+## Timeline
+<!-- What's the timeline for this Epic, what resources are needed, and what might potentially block this from hitting the projected end date. -->
+
+## Need for refinement
+<!-- Which questions are open? From whom do you need more input to fully specify the epic? -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 866963cb3..2c9a8820f 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,39 +1,33 @@
 ---
 name: Feature Request
-about: Help us improve the sovity CE EDC Connector product experience with new features suggestions
+about: Help us with new features
 title: ""
-labels: ["kind/enhancement", "task/analyze", "status/blocked/needs-product", "scope/ce"]
-assignees: ["AbdullahMuk"]
+labels: "kind/enhancement"
+assignees: ""
 ---
 
 # Feature Request
 
 ## Description
-
-_A clear and concise description of what the customer wants to happen._
-
+<!-- A clear and concise description of what the customer wants to happen. Example below. -->
 -   As a USER who PRECONDITIONS, I want to DO_THING, so I can ACCOMPLISH_GOAL.
 
 ## Which Areas Would Be Affected?
-
-_e.g., DPF, CI, build, transfer, etc._
+<!-- e.g., DPF, CI, build, transfer, etc. -->
 
 ## Why Is the Feature Desired?
+<!-- Are there any requirements? -->
 
-_What problems does that user face that existing functionalities do solve?_
-
-## How does this tie into the current product?
+## How does this tie into our current product?
+<!-- Describe whether this request is related to an existing workflow, feature, or otherwise something in the product today. Or, does this open us up to new markets and innovative ideas? -->
 
-_Describe whether this request is related to an existing workflow, feature, or otherwise something in the product today. Or, does this open us up to new innovative ideas?_
+## Stakeholders
+<!-- Add more on who asked for this, i.e. company, person, how much they pay us, what their tier is, are they a strategic account, etc. Who needs to be kept up-to-date about this feature? -->
 
-## (For sovity Team to complete) Stakeholders
-
-_Add more on who asked for this, i.e. company, person, how much they pay us, what their tier is, are they a strategic account, etc. Who needs to be kept up-to-date about this feature?_
-
-## (For sovity Team to complete) Solution Proposal and Work Breakdown
+## Solution Proposal and Work Breakdown
+<!-- If you already know what needs to be done, please add a tasklist. -->
 
 ```[tasklist]
 - [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
-- [ ] Refine further action items for this feature request
+- [ ] Refine a Solution Proposal / Work Breakdown
 ```
-
diff --git a/.github/ISSUE_TEMPLATE/process.md b/.github/ISSUE_TEMPLATE/process.md
new file mode 100644
index 000000000..4957c23cb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/process.md
@@ -0,0 +1,24 @@
+---
+name: Refine Process Request
+about: Existing processes must be adapted or new ones created
+title: ""
+labels: "task/documentation"
+assignees: ""
+---
+
+# Process Refinement Request
+
+## Description
+<!-- Provide a brief description of the process that needs refinement and the reason behind it. -->
+
+## Current State
+<!-- Describe the current state of the process, including any pain points or inefficiencies. -->
+
+## Proposed Changes
+<!-- Outline the changes that need to be made to improve the process. Be as specific as possible. -->
+
+## Related Issues or PRs
+<!-- If there are any related issues or pull requests, mention them here. -->
+
+## Additional Information
+<!-- Any additional information or context that may be helpful for understanding the issue. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index f23f70347..fb93cb530 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,43 @@
+# Pull Request
 
-_What issues does this PR close?_
+_Briefly describe WHAT your PR changes, which features it adds/modifies._
 
+## How Has This Been Tested?
 
-```[tasklist]
-### Checklist
-- [ ] The PR title is short and expressive.
-- [ ] I have updated the CHANGELOG.md. See [changelog_update.md](https://github.com/sovity/edc-extensions/tree/main/docs/dev/changelog_updates.md) for more information.
-- [ ] I have updated the Deployment Migration Notes Section in the CHANGELOG.md for any configuration / external API changes.
-- [ ] I have performed a **self-review**
-```
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
 
+-   Test A
+-   Test B
+-   ...
+
+**Test Configuration**:
+
+-   Firmware version:
+-   Hardware:
+-   Toolchain:
+-   SDK:
+
+## Linked Issue(s)
+
+_Use keywords to automate: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword_
+
+-   fixes # (issue)
+-   closes # (issue)
+-   ...
+
+## PR is blocked by
+
+-   [ ] blocked by # (issue)
+
+# Checklist
+
+-   [ ] I have **formatted the title** correctly and precisely
+-   [ ] My code follows the **style guidelines** of this project
+-   [ ] I have performed a **self-review** of my own code
+-   [ ] I have **commented** my code, particularly in hard-to-understand areas and public classes/methods
+-   [ ] I have made corresponding changes to the **documentation**
+-   [ ] My changes generate **no new warnings** (performed checkstyle check locally)
+-   [ ] 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
+-   [ ] Any dependent **changes have been merged** and published in downstream modules
+-   [ ] I have added/updated **copyright headers**
diff --git a/.github/workflows/add_pullrequest_to_project.yml b/.github/workflows/add_pullrequest_to_project.yml
index 9ca64829c..08fc53826 100644
--- a/.github/workflows/add_pullrequest_to_project.yml
+++ b/.github/workflows/add_pullrequest_to_project.yml
@@ -5,6 +5,7 @@ on:
 
 jobs:
   add_pullrequest_to_project:
+    if: github.actor != 'dependabot' && github.actor != 'sovitybot' # ignore PRs from bots
     name: add_pullrequest_to_project
     runs-on: ubuntu-latest
     steps: