Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add quickstart template #71

Merged
merged 34 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
e694ab9
chore: add quickstart template
marcellmueller Nov 26, 2024
13678d8
chore: remove unused graphics
marcellmueller Nov 26, 2024
3b7081f
chore: comment action builder keep_versions
marcellmueller Nov 26, 2024
04b2dce
chore: fix test job needs dependency
marcellmueller Nov 26, 2024
2e25364
chore: uncomment keep_versions ghcr builder input
marcellmueller Nov 26, 2024
f73bd12
docs: cleanup quickstart readme
marcellmueller Nov 26, 2024
7dd175c
docs: change project name
marcellmueller Nov 26, 2024
6060723
chore: comment workflows that use openshift
marcellmueller Nov 26, 2024
cddac62
chore: bump action-builder-ghcr action to v2.3.0
marcellmueller Nov 26, 2024
49ca60e
fix: eslint parser options tsconfig route
marcellmueller Nov 26, 2024
44c0174
chore: add backend/.env.example
marcellmueller Nov 26, 2024
242dc3b
chore: update api port
marcellmueller Nov 26, 2024
6bfffab
chore: add frontend/.env.example
marcellmueller Nov 26, 2024
0765308
chore: move prettier config up one directory
marcellmueller Nov 26, 2024
2250574
chore: cleanup unused var
marcellmueller Nov 26, 2024
4105483
chore: add makefile
marcellmueller Nov 26, 2024
98a007b
fix: vite.config.ts not reading env vars
marcellmueller Nov 27, 2024
5cbdd79
chore: remove mui
marcellmueller Nov 28, 2024
3074066
chore: add bcparks bootstrap theme
marcellmueller Nov 28, 2024
d6c20b5
chore: update readme
marcellmueller Nov 28, 2024
f3554cc
chore: replace jest with vitest in backend project
marcellmueller Nov 28, 2024
8dacf8b
chore: remove mui from vite rollup options
marcellmueller Nov 28, 2024
7f0e2f7
chore: add pre-commit
marcellmueller Nov 29, 2024
8004fe1
docs: add pre-commit setup
marcellmueller Nov 29, 2024
6778cb0
chore: run pre-commit on all files
marcellmueller Nov 29, 2024
405628f
chore: add base eslint config and migrate to eslint 9 flat config
marcellmueller Nov 29, 2024
2cd96cf
chore: run eslint on entire project and fix linting errors
marcellmueller Nov 29, 2024
9c87aa7
chore: fix build issue
marcellmueller Nov 29, 2024
6db481d
chore: add pre-commit and commitlint workflow checks
marcellmueller Dec 2, 2024
ce04339
chore: clean up pre-commit workflow
marcellmueller Dec 2, 2024
3fb3913
docs: update local development documentation
marcellmueller Dec 2, 2024
9150438
chore: use prettier to format markdown files
marcellmueller Dec 2, 2024
252e9a7
chore: fix frontend test
marcellmueller Dec 2, 2024
b34290c
chore: fix backend tests
marcellmueller Dec 2, 2024
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
29 changes: 29 additions & 0 deletions .commitlintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
extends:
- "@commitlint/config-conventional"
rules:
header-max-length: [1, "always", 72]
type-enum:
- 2
- always
- - ci
- feat
- fix
- docs
- style
- refactor
- perf
- test
- revert
- chore
help: |
**Possible types**:
`ci`: Changes to our CI configuration files and scripts
`feat`: Adds a new feature
`fix`: Solves a bug
`docs`: Adds or modifies documentation
`style`: Improves formatting, white-space
`refactor`: Rewrites code without feature, performance or bug changes
`perf`: Improves performance
`test`: Adds or modifies tests
`revert`: Changes that reverting other changes
`chore`: Adds or modifies build scripts, no production code change
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 you expected to happen.

** 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: ''

---
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/decision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Decision
about: This is a big decision that has been made or raised to PO
title: ''
labels: decision
assignees: ''

---
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 and/or scientific documentation exists and can be found
- [ ] Peer Reviewed by 2 people on the team
- [ ] Manual testing of all PRs in Dev and Prod
- [ ] Merged
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
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 and/or scientific documentation exists and can be found
- [ ] Peer Reviewed by 2 people on the team
- [ ] Manual testing of all PRs in Dev and Prod
- [ ] Merged
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Question
about: Ask us a question!
title: ''
labels: question
assignees: ''

---

**Describe the task**
basic description of the task, is it focuse 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
28 changes: 14 additions & 14 deletions .github/ISSUE_TEMPLATE/task-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,35 @@ assignees: ''
---

#### Description:

[Description of the task]

#### Acceptance Criteria:
[Note: Use 'Given/When/Then' format if it makes sense to. Otherwise, a simple checklist that can be tested.]

#### Development Checklist:

- [ ] ...
- [ ] ...
- [ ] ...

#### Dependencies

- Blocked by
- Blocking

**Relevant documentation as reference**


**Definition of Ready**

- [ ] Acceptance criteria are included
- [ ] Wireframes are included (if applicable)
- [ ] Design / Solution is accepted by Product Owner (if applicable)
- [ ] Dependencies are identified (technical, business, regulatory/policy)
- [ ] Story has been estimated (under 13 pts)
**Definition of Done**

**Definition of Done**
- In progress:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] UI meets accessibility requirements
Expand All @@ -55,7 +55,7 @@ assignees: ''
- PO Review:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] Reviewed and approved by Product Owner

#### Notes:
-
-
-
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
38 changes: 19 additions & 19 deletions .github/ISSUE_TEMPLATE/user-story-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,49 +8,49 @@ assignees: ''
---

#### Description:

[User Story]

[Description of the ticket]

#### Acceptance Criteria:

Given
When
Then

Given
When
Then

#### Development Checklist:

- [ ] ...
- [ ] ...
- [ ] ...

#### Dependencies

- Blocked by
- Blocking

**Wireframe(s):**


**Workflows:**


**Definition of Ready** (Note: If any of these points are not applicable, mark N/A)

- [ ] User story is included
- [ ] User role and type are identified
- [ ] Acceptance criteria are included
- [ ] Wireframes are included
- [ ] Design / Solution is accepted by Product Owner
- [ ] Dependencies are identified (technical, business, regulatory/policy)
- [ ] Story has been estimated (under 13 pts)
**Definition of Done**

**Definition of Done**
- In progress:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] UI meets accessibility requirements
Expand All @@ -69,7 +69,7 @@ Then
- PO Review:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] Reviewed and approved by Product Owner

#### Notes:
-
-
-
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 focuse 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
Loading
Loading