Skip to content

Commit

Permalink
🔄 Templates: synced file(s) with sovity/PMO-Software (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
sovitybot authored Feb 26, 2024
1 parent 6eb8018 commit 805b8c2
Show file tree
Hide file tree
Showing 9 changed files with 152 additions and 156 deletions.
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Bug Report Template
description: Create a report to help us improve
labels: ["kind/bug"]
body:
- type: textarea
id: description
attributes:
label: Description - What happened? *
description: A clear and concise description of the bug.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior *
description: A clear and concise description of what you expected to happen.
placeholder: Tell us what you expected!
validations:
required: true
- type: textarea
id: observed
attributes:
label: Observed Behavior *
description: A clear and concise description of what happened instead.
placeholder: Tell us what you observed!
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior.
placeholder: Tell us how to reproduce the issue!
validations:
required: false
- type: textarea
id: context
attributes:
label: Context Information
description: Add any other context about the problem here.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots or other information to help explain your problem.
validations:
required: false
- type: markdown
attributes:
value: |
<sup>_* These fields are mandatory, without filling them it is not possible to create the issue._</sup>
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Security vulnerabilities
url: https://github.com/sovity/edc-extensions/security/policy
about: If you want to report a security issue, please contact us directly.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -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. -->
45 changes: 13 additions & 32 deletions .github/ISSUE_TEMPLATE/epic_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,52 +9,33 @@ 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._
<!-- 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?_

- Requirement 1
- Requirement 2
<!-- Which requirements do you have to be fulfilled? -->

## Work Breakdown
<!-- If you already know what needs to be done, plase add a tasklist. -->

_Create Stories which can be converted into issues_

- [ ] Story 1
- [ ] Story 2
- ...
```[tasklist]
### Stories
- [ ] Create Stories which can be converted into issues
```

## Initiative / goal

_Describe how this Epic impacts an initiative the business is working on._
<!-- 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._
<!-- 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._

- Criteria 1
- Criteria 2
- ...
<!-- 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._
<!-- 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._
<!-- 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?_

- Question 1
- Question 2
- ...
<!-- Which questions are open? From whom do you need more input to fully specify the epic? -->
26 changes: 10 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,25 @@ 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?_
<!-- Are there any requirements? -->

## 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 markets and 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?_
<!-- 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? -->

## Solution Proposal and Work Breakdown
<!-- If you already know what needs to be done, please add a tasklist. -->

_If possible, provide a (brief!) solution proposal._

- [ ] Step 1
- [ ] Step 2
- ...
```[tasklist]
- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
- [ ] Refine a Solution Proposal / Work Breakdown
```
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/process.md
Original file line number Diff line number Diff line change
@@ -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. -->
49 changes: 8 additions & 41 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,10 @@
# Pull Request
_What issues does this PR close?_

_Briefly describe WHAT your PR changes, which features it adds/modifies._

## How Has This Been Tested?

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**
```[tasklist]
### Checklist
- [ ] The PR title is short and expressive.
- [ ] I have updated the CHANGELOG.md. See [changelog_update.md](https://github.com/sovity/authority-portal/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**
```
16 changes: 0 additions & 16 deletions .github/workflows/add_pullrequest_to_project.yml

This file was deleted.

0 comments on commit 805b8c2

Please sign in to comment.