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._ + + ### Expected Behavior - -_A clear and concise description of what you expected to happen._ + ### Observed Behavior - -_A clear and concise description of what happened instead._ + ## Steps to Reproduce - -Steps to reproduce the behavior: + ## Context Information - -_Add any other context about the problem here._ + ## Possible Implementation and Work Breakdown + ```[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 + + +## Current Documentation + + +## Proposed Changes + + +## Justification + + +## Additional Context + + +## Deadline + + +## Notes + 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 + + +### Requirements + + +## Work Breakdown + + +```[tasklist] +### Stories +- [ ] Create Stories which can be converted into issues +``` + +## Initiative / goal + + +### Hypothesis + + +## Acceptance criteria and must have scope + + +## Stakeholders + + +## Timeline + + +## Need for refinement + 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._ - + - 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._ + ## Why Is the Feature Desired? + -_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 innovative ideas?_ +## Stakeholders + -## (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 + ```[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 + + +## Current State + + +## Proposed Changes + + +## Related Issues or PRs + + +## Additional Information + 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 354a936ce..08fc53826 100644 --- a/.github/workflows/add_pullrequest_to_project.yml +++ b/.github/workflows/add_pullrequest_to_project.yml @@ -5,7 +5,7 @@ on: jobs: add_pullrequest_to_project: - if: ${{ github.event.pull_request.head.repo.full_name == github.repository }} + if: github.actor != 'dependabot' && github.actor != 'sovitybot' # ignore PRs from bots name: add_pullrequest_to_project runs-on: ubuntu-latest steps: