Skip to content

Commit

Permalink
Merge branch 'main' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdburr authored Nov 29, 2024
2 parents 4525efb + 5fd3b10 commit af46155
Show file tree
Hide file tree
Showing 67 changed files with 4,591 additions and 860 deletions.
145 changes: 2 additions & 143 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,145 +1,4 @@
{
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"commitType": "docs",
"commitConvention": "angular",
"contributors": [
{
"login": "nbarlowATI",
"name": "nbarlowATI",
"avatar_url": "https://avatars.githubusercontent.com/u/33832774?v=4",
"profile": "https://github.com/nbarlowATI",
"contributions": [
"bug",
"code",
"doc",
"design",
"example",
"ideas",
"test"
]
},
{
"login": "mhauru",
"name": "Markus Hauru",
"avatar_url": "https://avatars.githubusercontent.com/u/5229876?v=4",
"profile": "http://mhauru.org",
"contributions": [
"bug",
"code",
"doc",
"design",
"example",
"ideas",
"test"
]
},
{
"login": "AoifeHughes",
"name": "Aoife Hughes",
"avatar_url": "https://avatars.githubusercontent.com/u/10923695?v=4",
"profile": "https://github.com/AoifeHughes",
"contributions": [
"bug",
"code",
"ideas",
"test"
]
},
{
"login": "entopia",
"name": "Flora",
"avatar_url": "https://avatars.githubusercontent.com/u/4749503?v=4",
"profile": "https://www.turing.ac.uk/people/researchers/flora-roumpani",
"contributions": [
"bug",
"code",
"doc",
"design",
"example",
"ideas"
]
},
{
"login": "chrisdburr",
"name": "Christopher Burr",
"avatar_url": "https://avatars.githubusercontent.com/u/63010234?v=4",
"profile": "https://github.com/chrisdburr",
"contributions": [
"bug",
"code",
"doc",
"design",
"example",
"ideas",
"test",
"review",
"talk",
"userTesting",
"research",
"promotion",
"projectManagement"
]
},
{
"login": "cassgvp",
"name": "Cassandra Gould van Praag",
"avatar_url": "https://avatars.githubusercontent.com/u/43407869?v=4",
"profile": "https://www.turing.ac.uk/research/harnessing-power-digital-twins/turing-research-and-innovation-cluster-digital-twins",
"contributions": [
"ideas",
"review",
"projectManagement",
"question",
"design"
]
},
{
"login": "kallewesterling",
"name": "Kalle Westerling",
"avatar_url": "https://avatars.githubusercontent.com/u/7298727?v=4",
"profile": "http://www.westerling.nu",
"contributions": [
"ideas",
"review",
"projectManagement",
"question",
"code"
]
},
{
"login": "aranas",
"name": "Sophie Arana",
"avatar_url": "https://avatars.githubusercontent.com/u/6906140?v=4",
"profile": "https://github.com/aranas",
"contributions": [
"ideas",
"review",
"projectManagement",
"question",
"design"
]
},
{
"login": "S-Laher",
"name": "Shakir Laher",
"avatar_url": "https://avatars.githubusercontent.com/u/45235675?v=4",
"profile": "https://github.com/S-Laher",
"contributions": [
"content",
"doc",
"ideas",
"research"
]
}
],
"contributorsPerLine": 7,
"skipCi": true,
"repoType": "github",
"repoHost": "https://github.com",
"projectName": "AssurancePlatform",
"projectOwner": "alan-turing-institute"
"projectName": "AssurancePlatform",
"projectOwner": "alan-turing-institute"
}
102 changes: 27 additions & 75 deletions .github/ISSUE_TEMPLATE/user-story.yaml
Original file line number Diff line number Diff line change
@@ -1,96 +1,48 @@
name: User Story
description: Create a new user story.
title: "[User Story]: "
labels: ["user-story"]
name: "User Story"
description: "Template for creating user stories in this repository"
labels: "user-story"

body:
- type: markdown
attributes:
value: |
Thank you for contributing a new user story! Please fill out the details below to help us understand your vision.
- type: input
id: role
id: user_role
attributes:
label: Role
description: Who is the user for this story?
placeholder: ex. As a [Admin]
label: "User Role"
description: "As a [type of user]"
placeholder: "e.g., Admin, Customer, Developer"
validations:
required: true

- type: input
id: feature
id: goal
attributes:
label: Desired Feature
description: What is the feature you would like to have?
placeholder: I want to [feature description]
label: "Goal / Desire"
description: "I want [some goal or desire]"
placeholder: "e.g., view user activity, manage settings"
validations:
required: true

- type: input
id: benefit
attributes:
label: Benefit
description: What is the benefit of this feature?
placeholder: So that I can [benefit description]
validations:
required: true

- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description:
Please describe the conditions that must be met for this story to be
considered complete.
placeholder: |
**GIVEN** [precondition]
**AND** [another precondition if necessary]
**WHEN** [action taken by the user]
**THEN** [expected outcome]
**AND** [another outcome if necessary]
label: "Benefit / Reason"
description: "So that [some benefit]"
placeholder: "e.g., improve productivity, ensure data security"
validations:
required: true

- type: textarea
id: dependencies
- type: checkboxes
id: acceptance_criteria
attributes:
label: Dependencies
description: Are there any other tasks that need to be completed first?
placeholder: |
- [ ] Dependency 1 (include issue link)
- [ ] Dependency 2 (include issue link)
validations:
required: false
label: "Acceptance Criteria"
description: "Define criteria for successful implementation. Check all that apply."
options:
- label: "Criterion 1"
- label: "Criterion 2"
- label: "Criterion 3"

- type: textarea
id: technical-notes
attributes:
label: Technical Notes
description:
Any technical notes, potential challenges, or architectural
considerations for implementation?
placeholder: |
- Note 1
- Note 2
validations:
required: false

- type: checkboxes
id: definition-of-done
id: additional_notes
attributes:
label: Definition of Done
description:
Please confirm the following are completed before this story can be
considered done.
options:
- label: The feature fulfills all acceptance criteria.
- label: The code is reviewed and meets team coding standards.
- label: All unit, integration, and end-to-end tests are passed.
- label: The feature meets accessibility standards set for the project.
- label:
The code passes the CI/CD pipeline quality controls (style and
linting).
- label: The feature is merged into the main branch.
- label: The feature is deployed and functional in the QA environment.
- label:
The feature was demonstrated to the team and accepted by the product
owner.
label: "Additional Notes / Considerations"
description: "Any additional context, links, screenshots, or other relevant information"
placeholder: "Add any extra notes here"
13 changes: 0 additions & 13 deletions .github/workflows/docs-publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,6 @@ on:
permissions:
contents: write
jobs:
pre-commit:
name: Format
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: "3.x"
- uses: pre-commit/[email protected]
with:
extra_args: --hook-stage manual --all-files
docs:
runs-on: ubuntu-latest
steps:
Expand Down
11 changes: 6 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ ci:

repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.4.1"
rev: "v0.7.4"
hooks:
- id: ruff
args: ["--fix", "--show-fixes"]
exclude: \.md$

- repo: https://github.com/psf/black
rev: "24.4.0"
rev: "24.10.0"
hooks:
- id: black
language: python
files: ^eap_backend/
exclude: \.md$

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: "v4.6.0"
rev: "v5.0.0"
hooks:
- id: check-added-large-files
- id: check-case-conflict
Expand All @@ -46,10 +46,11 @@ repos:
hooks:
- id: prettier
types_or: [yaml, html, css, scss, javascript, json]
args: [--prose-wrap=always]
exclude: \.md$
args: [--prose-wrap=never]

- repo: https://github.com/asottile/blacken-docs
rev: "1.16.0"
rev: "1.19.1"
hooks:
- id: blacken-docs
additional_dependencies: [black==23.3.0]
Expand Down
Loading

0 comments on commit af46155

Please sign in to comment.