Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the Bug**
A clear and concise description of what the bug is.

**Expected Behaviour**
A clear and concise description of what you expected to happen.

**Actual Behaviour**
A clear and concise description of what actually happened.

**Steps To Reproduce**
Steps to reproduce the behaviour:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Custom issue template
about: Describe this issue template's purpose here
title: ''
labels: ''
assignees: ''

---
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/decision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Decision
about: A significant decision that has been made or raised to the Product Owner
title: ''
labels: decision
assignees: ''

---

**Decision**
A clear and concise description of the decision to be made or that was made.

**Context**
- why is this decision needed?
- what options were considered?

**Outcome**
- the decision reached, and who made it
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Documentation
about: Documentation for a specific area or need
title: ''
labels: documentation
assignees: ''

---

**As a** *(User Type/Persona)* **I want** *(Feature/enhancement)* **So That** *(Value, why is this wanted, what is the user trying to accomplish)*

**Additional Context**
- enter text here
- enter text here

**Acceptance Criteria**
- [ ] Given (Context), When (action carried out), Then (expected outcome)
- [ ] Given (Context), When (action carried out), Then (expected outcome)

**Definition of Done**
- [ ] Ready to Demo in Sprint Review
- [ ] Does what I have made have appropriate test coverage?
- [ ] Documentation exists and can be found
- [ ] Peer Reviewed by the team
- [ ] Manual testing of all PRs in Dev and Prod
- [ ] Merged
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Epic
about: A User Story large enough that it cannot be completed in a single sprint, the desired end state of a feature
title: ''
labels: epic
assignees: ''

---

**As a** *(User Type/Persona)* **I want** *(Feature/enhancement)* **So That** *(Value, why is this wanted, what is the user trying to accomplish)*

**Additional Context**

- enter text here
- enter text here

**Acceptance Criteria**

- [ ] Given (Context), When (action carried out), Then (expected outcome)
- [ ] Given (Context), When (action carried out), Then (expected outcome)
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature request / user story
about: Suggest an idea from the perspective of a user
title: ''
labels: enhancement
assignees: ''

---

**As a** *(User Type/Persona)* **I want** *(Feature/enhancement)* **So That** *(Value, why is this wanted, what is the user trying to accomplish)*

**Additional Context**
- enter text here
- enter text here

**Acceptance Criteria**
- [ ] Given (Context), When (action carried out), Then (expected outcome)
- [ ] Given (Context), When (action carried out), Then (expected outcome)

**Definition of Done**
- [ ] Ready to Demo in Sprint Review
- [ ] Does what I have made have appropriate test coverage?
- [ ] Documentation exists and can be found
- [ ] Peer Reviewed by the team
- [ ] Manual testing of all PRs in Dev and Prod
- [ ] Merged
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Question
about: Ask us a question!
title: ''
labels: question
assignees: ''

---

**Your question**
A clear and concise statement of what you would like to know.

**Context**
- any background or details that help us answer the question

**Additional context**
- any additional details that could not be captured above
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Task
about: Work for the team that cannot be written as a user story
title: ''
labels: task
assignees: ''

---

**Describe the task**
A clear and concise description of what the task is.

**Acceptance Criteria**
- [ ] first
- [ ] second
- [ ] third

**Additional context**
- Add any other context about the task here.
- Or here
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/ux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: UX Task
about: This is a Task for UX Research, Design or Testing
title: ''
labels: ux
assignees: ''

---

**Describe the task**
Basic description of the task. Is it focused on research with users or the business area? Is it design focused on either co-design or wireframing? Is it user testing or compiling results?

**Acceptance Criteria**
- [ ] what is required for this task to be complete?
- what is the finishing point or end state of this task?
- [ ] what is the output of this task?

**SME/User Contact**
(may want to use a persona to fill this in)

**Additional context**
- any additional details that could not be captured above
15 changes: 15 additions & 0 deletions .github/codeowners
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Code owners for the SOBA repository.
#
# Owners listed here are automatically requested for review when someone opens
# a pull request that modifies matching files. Uncomment and fill in the GitHub
# handles for your team before relying on this.
#
# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Matched against repo root (asterisk)
# * @owner1 @owner2

# Matched against directories
# /.github/workflows/ @owner1 @owner2
# /backend/ @owner1 @owner2
# /frontend/ @owner1 @owner2
71 changes: 71 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<!--
Provide a general summary of your changes in the Title above, using the format:
type: CCP-1234 short description of your change

For example:
feat: CCP-1234 add submission export to CSV
-->

**References ticket:** CCP-NNNN

<!-- Replace NNNN with the Jira ticket number. If this also closes a GitHub issue, add a line below: Fixes #123 -->

# Description

Please provide a summary of the change and the issue fixed. Please include relevant context. List dependency changes.

## Type of change

<!-- Please delete options that are not relevant. -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Documentation update

# How Has This Been Tested?

<!-- Please describe the tests you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration -->

<!-- Please delete options that are not relevant. -->

- [ ] New unit tests
- [ ] New integration tests
- [ ] New end-to-end tests (Playwright)
- [ ] No new tests are required
- [ ] Manual tests (description below)
- [ ] Updated existing tests

## How to verify

<!--
Provide steps a reviewer can follow to confirm this PR does what it says it does,
ideally reproducible in another environment (e.g. the PR/dev deployment).

For a bug fix: first describe how to reproduce the original bug, then how to
confirm it no longer occurs with this change.
-->

1. ...
2. ...
3. Expected result: ...

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) doc
- [ ] 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
- [ ] I have run lint on the affected backend and/or frontend workspace
- [ ] 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
- [ ] Any dependent changes have already been accepted and merged

## Further comments

<!-- If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... -->
48 changes: 48 additions & 0 deletions .github/workflows/pr_validate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Validates the pull request title (conventional commits) and rejects forks.
# Only the PR title is checked — individual commits are not inspected — because
# merges use the PR title as the squash commit message.
name: PR Validate
run-name: PR-${{ github.event.number }} validate

on:
pull_request:
types: [opened, edited, reopened, synchronize, ready_for_review]

permissions:
pull-requests: read

concurrency:
group: ${{ github.workflow }}-${{ github.event.number }}
cancel-in-progress: true

jobs:
validate:
name: Validate PR
runs-on: ubuntu-latest
if: ${{ !github.event.pull_request.draft }}
steps:
- name: Reject forks
if: github.event.pull_request.head.repo.full_name != github.repository
run: |
echo "::error::Pull requests from forks are not accepted. Please create a branch in this repository and open your PR from there."
exit 1

- name: Validate PR title
uses: amannn/action-semantic-pull-request@v6
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
# Allowed conventional-commit types. The Jira id (e.g. CCP-1234)
# belongs in the subject: "feat: CCP-1234 add submission export".
types: |
feat
fix
build
ci
docs
perf
refactor
revert
style
test
chore
4 changes: 2 additions & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@
"name": "SOBA Frontend (Chrome)",
"type": "chrome",
"request": "launch",
"url": "http://localhost:5173",
"webRoot": "${workspaceFolder}/frontend/src"
"url": "http://localhost:3000",
"webRoot": "${workspaceFolder}/frontend"
}
]
}
Loading
Loading