Skip to content

Commit

Permalink
docs(sovity-daps): issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sybereal committed Apr 30, 2024
1 parent 20f691d commit ba7dd62
Show file tree
Hide file tree
Showing 10 changed files with 312 additions and 0 deletions.
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: Report a bug 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>
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
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. -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Enhancement
about: Implement a task / improve something
title: ''
labels: kind/enhancement
assignees: ''

---

# Enhancement

## 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.

## 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?_

## Solution Proposal and Work Breakdown

```[tasklist]
- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
- [ ] Refine a Solution Proposal / Work Breakdown
```
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/epic_template.md
Original file line number Diff line number Diff line change
@@ -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? -->
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Feature Request
about: Help us with new features
title: ""
labels: "kind/enhancement"
assignees: ""
---

# Feature Request

## Description
<!-- 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. -->

## Why Is the Feature Desired?
<!-- 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? -->

## 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? -->

## 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 a Solution Proposal / Work Breakdown
- [ ] (For Tech Team): Include acceptance criteria for the sub-tasks of the work breakdown
```
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/mds_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: MDS Feature Request
about: Help us improve your product experience with new features suggestions
title: ''
labels: kind/enhancement
assignees: jkbquabeck

---

# 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?

_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?_

## (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

```[tasklist]
- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
- [ ] Refine further action items for this feature request
```
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. -->
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Release
about: Create an issue to track a release process.
title: "Release x.x.x"
labels: ["task/release", "scope/mds"]
assignees: ""
---

# Release

## Work Breakdown

Feel free to edit this release checklist in-progress depending on what tasks need to be done:

- [ ] Decide a release version depending on major/minor/patch changes in the CHANGELOG.md.
- [ ] Update this issue's title to the new version
- [ ] `release-prep` PR:
- [ ] Update the CHANGELOG.md.
- [ ] Add a clean `Unreleased` version.
- [ ] Add the version to the old section.
- [ ] Add the current date to the old version.
- [ ] Write or review the `Deployment Migration Notes` section.
- [ ] Ensure the `Deployment Migration Notes` contains the compatible docker images.
- [ ] Write or review a release summary.
- [ ] Remove empty sections from the patch notes.
- [ ] Merge the `release-prep` PR.
- [ ] Wait for the main branch to be green.
- [ ] Deploy a version with the "main" and test the deployment.
- [ ] Create a release and re-use the changelog section as release description, and the version as title.
- [ ] Create a release in the [Authority Portal EE](https://github.com/sovity/authority-portal-ee) repository.
- [ ] `release-prep` PR:
- [ ] Copy the [Keycloak theme](https://github.com/sovity/authority-portal/tree/main/authority-portal-keycloak) from here to the EE repository.
- [ ] Copy the [OAuth2 proxy templates](https://github.com/sovity/authority-portal/tree/main/authority-portal-oauth2-proxy) from here to the EE repository.
- [ ] Copy the [realm.json](https://github.com/sovity/authority-portal/blob/main/authority-portal-backend/authority-portal-quarkus/src/main/resources/realm.json) from here to the EE repository.
- [ ] Link this release in the EE changelog.
- [ ] Merge the `release-prep` PR.
- [ ] Create a release, re-use the changelog section as EE release description.
- [ ] Re-use the version of this release as the title for the EE release.
- [ ] Notify the deployment team, which will send a message to the customer about the new release.
- [ ] `release-cleanup` PR:
- [ ] Revisit the changed list of tasks and compare it
with [.github/ISSUE_TEMPLATE/release.md](https://github.com/sovity/authority-portal/blob/main/.github/ISSUE_TEMPLATE/release.md).
Apply changes where it makes sense.
- [ ] Merge the `release-cleanup` PR.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
_What issues does this PR close?_


```[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**
```

0 comments on commit ba7dd62

Please sign in to comment.