Repository: ministryofjustice/laa-crime-assessment-service
Pull request #2: Initial set-up for the Assessment Service repo
Author: login: sophiebrown01
Created: 2025-05-09T15:17:22Z | Merged: 2025-05-14T15:43:13Z

This PR adds some initial set-up for the Assessment Service repo, specifically updates to the README with basic information about the service, a pull request template, code owners for pull requests and additional exclusions via the .gitignore file.

[Link to story](https://dsdmoj.atlassian.net/browse/LCAM-1702)


Diff:
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index ca944a6b..1065a335 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,3 +1,2 @@
-# Add a team or username to this file
-# Example:
-# *   @ministryofjustice/github-community
+# GitHub users/groups automatically requested to review App code on PR
+* @ministryofjustice/laa-crime-apps-team
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index 15fe7f0f..78c1bd87 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -7,31 +7,11 @@
 version: 2
 
 updates:
-  - package-ecosystem: "bundler"
-    directory: "/"
+  - package-ecosystem: "gradle"
+    directory: "/crime-assessment-service"
     schedule:
-      interval: "daily"
-  - package-ecosystem: "terraform"
-    directory: "/terraform"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "gomod"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "docker"
-    directory: "/"
-    schedule:
-      interval: "daily"
+      interval: "weekly"
+    commit-message:
+      prefix: "Gradle"
+      include: "scope"
+
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..c4fea18b
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,19 @@
+## What
+
+[Link to story](https://dsdmoj.atlassian.net/browse/LCAM-XXX)
+
+Describe what you did and why.
+
+## Checklist
+
+Before you ask people to review this PR:
+
+- [ ] Tests should be passing: `./gradlew test`
+- [ ] Github should not be reporting conflicts; you should have recently run `git rebase main`.
+- [ ] Avoid mixing whitespace changes with code changes in the same commit. These make diffs harder to read and conflicts more likely.
+- [ ] You should have looked at the diff against main and ensured that nothing unexpected is included in your changes.
+- [ ] You should have checked that the commit messages say why the change was made.
+
+## Additional checks
+
+- Don’t forget to [run](https://github.com/ministryofjustice/laa-crimeapps-maat-functional-tests/actions/workflows/ExecuteUiTests.yaml) the MAAT functional test suite after deploying your changes to the DEV or TEST environments to ensure your changes haven’t broken any of the functional tests.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
new file mode 100644
index 00000000..1e479036
--- /dev/null
+++ b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,52 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '0 8 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: 'ubuntu-latest'
+    permissions:
+      # required for all workflows
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ "java" ]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Add any setup steps before running the `github/codeql-action/init` action.
+      # This includes steps like installing compilers or runtimes (`actions/setup-node`
+      # or others). This is typically only required for manual builds.
+      # - name: Setup runtime (example)
+      #   uses: actions/setup-example@v1
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
diff --git a/.gitignore b/.gitignore
index aa69ef32..6daf08ca 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,6 @@
 .env
+.java-version
+.idea/
 .terraform/
 coverage/
 venv/
diff --git a/README.md b/README.md
index 0234dec8..c3cf4b2b 100644
--- a/README.md
+++ b/README.md
@@ -1,70 +1,68 @@
-# Ministry of Justice Template Repository
+# Crime Assessment Service
 
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/template-repository/badge)](https://github-community.service.justice.gov.uk/repository-standards/template-repository)
+The Crime Assessment Service is a Spring Modulith application which handles multiple types of assessments that can be made as part of a criminal legal aid application. These include but are not limited to: means assessments, Interest of Justice (IoJ) appeals, passported benefits and hardship reviews. Each of the different assessment types is encapsulated within a separate application module.
 
-This template repository equips you with the default initial files required for a Ministry of Justice GitHub repository.
+The main consumer of the Crime Assessment Service is the Orchestration Service, which previously made requests to many of the individual microservices that now live within this service.
 
-## Included Files
+[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/laa-crime-assessment-service/badge)](https://github-community.service.justice.gov.uk/repository-standards/laa-crime-assessment-service)
 
-The repository comes with the following preset files:
+## Technical documentation
 
-- LICENSE
-- .gitignore
-- CODEOWNERS
-- dependabot.yml
-- GitHub Actions example files
-- Ministry of Justice Compliance Badge (public repositories only)
+This service uses Java 21 and is built using Spring Modulith. It is hosted on the Moj Cloud Platform and runs within Kubernetes.
 
-## Setup Instructions
+## Getting started
 
-Once you've created your repository using this template, ensure the following steps:
+### Application set-up
 
-### Update README
-
-Edit this README.md file to document your project accurately. Take the time to create a clear, engaging, and informative README.md file. Include information like what your project does, how to install and run it, how to contribute, and any other pertinent details.
-
-### Update repository description
-
-After you've created your repository, GitHub provides a brief description field that appears on the top of your repository's main page. This is a summary that gives visitors quick insight into the project. Using this field to provide a succinct overview of your repository is highly recommended.
-
-This description and your README.md will be one of the first things people see when they visit your repository. It's a good place to make a strong, concise first impression. Remember, this is often visible in search results on GitHub and search engines, so it's also an opportunity to help people discover your project.
-
-### Grant Team Permissions
-
-Assign permissions to the appropriate Ministry of Justice teams. Ensure at least one team is granted Admin permissions. Whenever possible, assign permissions to teams rather than individual users.
+```
+git clone git@github.com:ministryofjustice/laa-crime-assessment-service.git
 
-Prefer to user GitHub Teams over individual access to repositories. Where appropriate, ensure GitHub Teams used are related to a Parent Team associated with a Business Unit to help ensure ownership can be easily identified.
+cd laa-crime-assessment-service
+```
 
-### Read about the GitHub repository standards
+### Java set-up
 
-Familiarise yourself with the Ministry of Justice GitHub Repository Standards. These standards ensure consistency, maintainability, and best practices across all our repositories.
+If you do not already have Java 21 installed, you will need to install it. There are many ways to do this, but a recommended approach
+is to use [jenv](https://github.com/jenv/jenv) to manage your local Java versions and enable easy switching between them. jenv will
+also automatically switch to use the correct Java version when you navigate to a project containing a `.java-version` file (providing
+it is already installed).
 
-You can find the standards [here](https://github-community.service.justice.gov.uk/repository-standards/guidance).
+```sh
+# Check your current Java version - if it is Java 21 then the rest of the following steps are optional
+java -version
 
-Please read and understand these standards thoroughly and enable them when you feel comfortable.
+brew update
 
-### Modify the GitHub Standards Badge
+brew install jenv
+brew install openjdk@21
 
-Once you've ensured that all the [GitHub Repository Standards](https://github-community.service.justice.gov.uk/repository-standards/guidance) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README file.
+# See the output from the previous command to determine where Java 21 was installed
+# You may need to symlink to your JavaVirtualMachines directory from the installed location to be able to use it
+jenv add /path/to/Java/Contents/Home
 
-The badge demonstrates that your repository is compliant with MoJ's standards.
+# Check to ensure that you can see Java 21 now listed
+jenv versions
 
-To update the badge, replace the `template-repository` in the badge URL with your repository's name. The badge URL should look like this:
+# Switch to Java 21 (ensure you're still inside the laa-crime-assessment-service directory)
+jenv local 21
 
-```markdown
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/${your-repository-name}/badge)](https://github-community.service.justice.gov.uk/repository-standards/${your-reposistory-name})
+# Confirm that Java 21 is now the current Java version
+java -version
 ```
 
-**Please note** the badge will not function correctly if your repository is internal or private. In this case, you may remove the badge from your README.
-
-### Update CODEOWNERS
+### Running tests
 
-(Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests.
+To build the project:
 
-### Configure Dependabot
+```sh
+./gradlew clean build
+```
 
-Adapt the dependabot.yml file to match your project's [dependency manager](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem) and to enable [automated pull requests for package updates](https://docs.github.com/en/code-security/supply-chain-security).
+Ensure that all tests are passing by running:
 
-### Dependency Review
+```sh
+./gradlew clean test
+```
 
-If your repository is private with no GitHub Advanced Security license, remove the `.github/workflows/dependency-review.yml` file.
+Note: the `clean` task in the above two commands is optional but ensures that the build directory is
+removed first, ensuring that there are no leftovers remaining of previous builds.


Reviews:
user: login: nigelpain
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-14T09:32:53Z
user: login: Mhowell494
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-14T11:46:18Z
user: login: sophiebrown01
state: COMMENTED
author_association: COLLABORATOR
submitted_at: 2025-05-14T13:46:39Z
user: login: sophiebrown01
state: COMMENTED
author_association: COLLABORATOR
submitted_at: 2025-05-14T13:47:23Z
user: login: sophiebrown01
state: COMMENTED
author_association: COLLABORATOR
submitted_at: 2025-05-14T14:20:53Z
user: login: Mhowell494
body: LG2M — thanks for adding the PR checks too, I'd forgotten about this
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-14T15:14:47Z

Review comments:
diff_hunk: @@ -1,70 +1,65 @@
-# Ministry of Justice Template Repository
+# Crime Assessment Service
 
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/template-repository/badge)](https://github-community.service.justice.gov.uk/repository-standards/template-repository)
+The Crime Assessment Service is a Spring Modulith application which handles multiple types of assessments that can be made as part of a criminal legal aid application. These include but are not limited to: means assessments, Interest of Justice (IoJ) appeals, passported benefits and hardship reviews. Each of the different assessment types is encapsulated within a separate application module.
 
-This template repository equips you with the default initial files required for a Ministry of Justice GitHub repository.
+The main consumer of the Crime Assessment Service is the Orchestration Service, which previously made requests to many of the individual microservices that now live within this service.
 
-## Included Files
+[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/laa-crime-assessment-service/badge)](https://github-community.service.justice.gov.uk/repository-standards/laa-crime-assessment-service)
 
-The repository comes with the following preset files:
+## Technical documentation
 
-- LICENSE
-- .gitignore
-- CODEOWNERS
-- dependabot.yml
-- GitHub Actions example files
-- Ministry of Justice Compliance Badge (public repositories only)
+This service uses Java 21 and is built using Spring Modulith. It is hosted on the Moj Cloud Platform and runs within Kubernetes.
 
-## Setup Instructions
+## Getting started
 
-Once you've created your repository using this template, ensure the following steps:
+### Application set-up
 
-### Update README
-
-Edit this README.md file to document your project accurately. Take the time to create a clear, engaging, and informative README.md file. Include information like what your project does, how to install and run it, how to contribute, and any other pertinent details.
-
-### Update repository description
-
-After you've created your repository, GitHub provides a brief description field that appears on the top of your repository's main page. This is a summary that gives visitors quick insight into the project. Using this field to provide a succinct overview of your repository is highly recommended.
-
-This description and your README.md will be one of the first things people see when they visit your repository. It's a good place to make a strong, concise first impression. Remember, this is often visible in search results on GitHub and search engines, so it's also an opportunity to help people discover your project.
-
-### Grant Team Permissions
-
-Assign permissions to the appropriate Ministry of Justice teams. Ensure at least one team is granted Admin permissions. Whenever possible, assign permissions to teams rather than individual users.
+```
+git clone git@github.com:ministryofjustice/laa-crime-assessment-service.git
 
-Prefer to user GitHub Teams over individual access to repositories. Where appropriate, ensure GitHub Teams used are related to a Parent Team associated with a Business Unit to help ensure ownership can be easily identified.
+cd laa-crime-assessment-service
+```
 
-### Read about the GitHub repository standards
+### Java set-up
 
-Familiarise yourself with the Ministry of Justice GitHub Repository Standards. These standards ensure consistency, maintainability, and best practices across all our repositories.
+If you do not already have Java 21 installed, you will need to install it. There are many ways to do this, but a recommended approach
+is to use [jenv](https://github.com/jenv/jenv) to manage your local Java versions and enable easy switching between them. jenv will
+also automatically switch to use the correct Java version when you navigate to a project containing a `.java-version` file (providing
+it is already installed).
 
-You can find the standards [here](https://github-community.service.justice.gov.uk/repository-standards/guidance).
+```sh
+# Check your current Java version - if it is Java 21 then the rest of the following steps are optional
+java -version
 
-Please read and understand these standards thoroughly and enable them when you feel comfortable.
+brew update
 
-### Modify the GitHub Standards Badge
+brew install jenv
+brew install openjdk@21
 
-Once you've ensured that all the [GitHub Repository Standards](https://github-community.service.justice.gov.uk/repository-standards/guidance) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README file.
+# See the output from the previous command to determine where Java 21 was installed
+# You may need to symlink to your JavaVirtualMachines directory from the installed location to be able to use it
+jenv add /path/to/Java/Contents/Home
 
-The badge demonstrates that your repository is compliant with MoJ's standards.
+# Check to ensure that you can see Java 21 now listed
+jenv versions
 
-To update the badge, replace the `template-repository` in the badge URL with your repository's name. The badge URL should look like this:
+# Switch to Java 21 (ensure you're still inside the laa-crime-assessment-service directory)
+jenv local 21
 
-```markdown
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/${your-repository-name}/badge)](https://github-community.service.justice.gov.uk/repository-standards/${your-reposistory-name})
+# Confirm that Java 21 is now the current Java version
+java -version
 ```
 
-**Please note** the badge will not function correctly if your repository is internal or private. In this case, you may remove the badge from your README.
-
-### Update CODEOWNERS
+### Running tests
 
-(Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests.
+Make sure tests all testes are passed by running following ‘gradle’ Command
path: README.md
user: login: nigelpain
body: Sentence is a little wonky, I assume you meant something like **Make sure all tests are passing by running the following `gradle` command:**?
created_at: 2025-05-14T09:25:08Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,19 @@
+## What
+
+[Link to story](https://dsdmoj.atlassian.net/browse/LCAM-XXX)
+
+Describe what you did and why.
+
+## Checklist
+
+Before you ask people to review this PR:
+
+- [ ] Tests should be passing: `./gradlew test`
+- [ ] Github should not be reporting conflicts; you should have recently run `git rebase main`.
+- [ ] Avoid mixing whitespace changes with code changes in the same commit. These make diffs harder to read and conflicts more likely.
+- [ ] You should have looked at the diff against main and ensured that nothing unexpected is included in your changes.
+- [ ] You should have checked that the commit messages say why the change was made.
path: .github/pull_request_template.md
user: login: nigelpain
body: Should we include some mention of conventional commits and that messages should try and follow this or is it a bit early yet?
created_at: 2025-05-14T09:31:42Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,19 @@
+## What
+
+[Link to story](https://dsdmoj.atlassian.net/browse/LCAM-XXX)
+
+Describe what you did and why.
+
+## Checklist
+
+Before you ask people to review this PR:
+
+- [ ] Tests should be passing: `./gradlew test`
+- [ ] Github should not be reporting conflicts; you should have recently run `git rebase main`.
+- [ ] Avoid mixing whitespace changes with code changes in the same commit. These make diffs harder to read and conflicts more likely.
+- [ ] You should have looked at the diff against main and ensured that nothing unexpected is included in your changes.
+- [ ] You should have checked that the commit messages say why the change was made.
path: .github/pull_request_template.md
user: login: Mhowell494
body: I think it's a bit early, we can update the documentation once we've agreed on the implementation :)
created_at: 2025-05-14T11:46:18Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,19 @@
+## What
+
+[Link to story](https://dsdmoj.atlassian.net/browse/LCAM-XXX)
+
+Describe what you did and why.
+
+## Checklist
+
+Before you ask people to review this PR:
+
+- [ ] Tests should be passing: `./gradlew test`
+- [ ] Github should not be reporting conflicts; you should have recently run `git rebase main`.
+- [ ] Avoid mixing whitespace changes with code changes in the same commit. These make diffs harder to read and conflicts more likely.
+- [ ] You should have looked at the diff against main and ensured that nothing unexpected is included in your changes.
+- [ ] You should have checked that the commit messages say why the change was made.
path: .github/pull_request_template.md
user: login: sophiebrown01
body: I did have a section in here under the checklist which went into detail about what constitutes an approvable PR, but I've pulled it for now until we're ready to actually add it.
created_at: 2025-05-14T13:46:39Z
author_association: COLLABORATOR
diff_hunk: @@ -1,70 +1,65 @@
-# Ministry of Justice Template Repository
+# Crime Assessment Service
 
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/template-repository/badge)](https://github-community.service.justice.gov.uk/repository-standards/template-repository)
+The Crime Assessment Service is a Spring Modulith application which handles multiple types of assessments that can be made as part of a criminal legal aid application. These include but are not limited to: means assessments, Interest of Justice (IoJ) appeals, passported benefits and hardship reviews. Each of the different assessment types is encapsulated within a separate application module.
 
-This template repository equips you with the default initial files required for a Ministry of Justice GitHub repository.
+The main consumer of the Crime Assessment Service is the Orchestration Service, which previously made requests to many of the individual microservices that now live within this service.
 
-## Included Files
+[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/laa-crime-assessment-service/badge)](https://github-community.service.justice.gov.uk/repository-standards/laa-crime-assessment-service)
 
-The repository comes with the following preset files:
+## Technical documentation
 
-- LICENSE
-- .gitignore
-- CODEOWNERS
-- dependabot.yml
-- GitHub Actions example files
-- Ministry of Justice Compliance Badge (public repositories only)
+This service uses Java 21 and is built using Spring Modulith. It is hosted on the Moj Cloud Platform and runs within Kubernetes.
 
-## Setup Instructions
+## Getting started
 
-Once you've created your repository using this template, ensure the following steps:
+### Application set-up
 
-### Update README
-
-Edit this README.md file to document your project accurately. Take the time to create a clear, engaging, and informative README.md file. Include information like what your project does, how to install and run it, how to contribute, and any other pertinent details.
-
-### Update repository description
-
-After you've created your repository, GitHub provides a brief description field that appears on the top of your repository's main page. This is a summary that gives visitors quick insight into the project. Using this field to provide a succinct overview of your repository is highly recommended.
-
-This description and your README.md will be one of the first things people see when they visit your repository. It's a good place to make a strong, concise first impression. Remember, this is often visible in search results on GitHub and search engines, so it's also an opportunity to help people discover your project.
-
-### Grant Team Permissions
-
-Assign permissions to the appropriate Ministry of Justice teams. Ensure at least one team is granted Admin permissions. Whenever possible, assign permissions to teams rather than individual users.
+```
+git clone git@github.com:ministryofjustice/laa-crime-assessment-service.git
 
-Prefer to user GitHub Teams over individual access to repositories. Where appropriate, ensure GitHub Teams used are related to a Parent Team associated with a Business Unit to help ensure ownership can be easily identified.
+cd laa-crime-assessment-service
+```
 
-### Read about the GitHub repository standards
+### Java set-up
 
-Familiarise yourself with the Ministry of Justice GitHub Repository Standards. These standards ensure consistency, maintainability, and best practices across all our repositories.
+If you do not already have Java 21 installed, you will need to install it. There are many ways to do this, but a recommended approach
+is to use [jenv](https://github.com/jenv/jenv) to manage your local Java versions and enable easy switching between them. jenv will
+also automatically switch to use the correct Java version when you navigate to a project containing a `.java-version` file (providing
+it is already installed).
 
-You can find the standards [here](https://github-community.service.justice.gov.uk/repository-standards/guidance).
+```sh
+# Check your current Java version - if it is Java 21 then the rest of the following steps are optional
+java -version
 
-Please read and understand these standards thoroughly and enable them when you feel comfortable.
+brew update
 
-### Modify the GitHub Standards Badge
+brew install jenv
+brew install openjdk@21
 
-Once you've ensured that all the [GitHub Repository Standards](https://github-community.service.justice.gov.uk/repository-standards/guidance) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README file.
+# See the output from the previous command to determine where Java 21 was installed
+# You may need to symlink to your JavaVirtualMachines directory from the installed location to be able to use it
+jenv add /path/to/Java/Contents/Home
 
-The badge demonstrates that your repository is compliant with MoJ's standards.
+# Check to ensure that you can see Java 21 now listed
+jenv versions
 
-To update the badge, replace the `template-repository` in the badge URL with your repository's name. The badge URL should look like this:
+# Switch to Java 21 (ensure you're still inside the laa-crime-assessment-service directory)
+jenv local 21
 
-```markdown
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/${your-repository-name}/badge)](https://github-community.service.justice.gov.uk/repository-standards/${your-reposistory-name})
+# Confirm that Java 21 is now the current Java version
+java -version
 ```
 
-**Please note** the badge will not function correctly if your repository is internal or private. In this case, you may remove the badge from your README.
-
-### Update CODEOWNERS
+### Running tests
 
-(Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests.
+Make sure tests all testes are passed by running following ‘gradle’ Command
path: README.md
user: login: sophiebrown01
body: Thanks Nigel, I copied this bit from another README so the sentence is wonky in a few places. Will update now!
created_at: 2025-05-14T13:47:23Z
author_association: COLLABORATOR
diff_hunk: @@ -1,70 +1,65 @@
-# Ministry of Justice Template Repository
+# Crime Assessment Service
 
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/template-repository/badge)](https://github-community.service.justice.gov.uk/repository-standards/template-repository)
+The Crime Assessment Service is a Spring Modulith application which handles multiple types of assessments that can be made as part of a criminal legal aid application. These include but are not limited to: means assessments, Interest of Justice (IoJ) appeals, passported benefits and hardship reviews. Each of the different assessment types is encapsulated within a separate application module.
 
-This template repository equips you with the default initial files required for a Ministry of Justice GitHub repository.
+The main consumer of the Crime Assessment Service is the Orchestration Service, which previously made requests to many of the individual microservices that now live within this service.
 
-## Included Files
+[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/laa-crime-assessment-service/badge)](https://github-community.service.justice.gov.uk/repository-standards/laa-crime-assessment-service)
 
-The repository comes with the following preset files:
+## Technical documentation
 
-- LICENSE
-- .gitignore
-- CODEOWNERS
-- dependabot.yml
-- GitHub Actions example files
-- Ministry of Justice Compliance Badge (public repositories only)
+This service uses Java 21 and is built using Spring Modulith. It is hosted on the Moj Cloud Platform and runs within Kubernetes.
 
-## Setup Instructions
+## Getting started
 
-Once you've created your repository using this template, ensure the following steps:
+### Application set-up
 
-### Update README
-
-Edit this README.md file to document your project accurately. Take the time to create a clear, engaging, and informative README.md file. Include information like what your project does, how to install and run it, how to contribute, and any other pertinent details.
-
-### Update repository description
-
-After you've created your repository, GitHub provides a brief description field that appears on the top of your repository's main page. This is a summary that gives visitors quick insight into the project. Using this field to provide a succinct overview of your repository is highly recommended.
-
-This description and your README.md will be one of the first things people see when they visit your repository. It's a good place to make a strong, concise first impression. Remember, this is often visible in search results on GitHub and search engines, so it's also an opportunity to help people discover your project.
-
-### Grant Team Permissions
-
-Assign permissions to the appropriate Ministry of Justice teams. Ensure at least one team is granted Admin permissions. Whenever possible, assign permissions to teams rather than individual users.
+```
+git clone git@github.com:ministryofjustice/laa-crime-assessment-service.git
 
-Prefer to user GitHub Teams over individual access to repositories. Where appropriate, ensure GitHub Teams used are related to a Parent Team associated with a Business Unit to help ensure ownership can be easily identified.
+cd laa-crime-assessment-service
+```
 
-### Read about the GitHub repository standards
+### Java set-up
 
-Familiarise yourself with the Ministry of Justice GitHub Repository Standards. These standards ensure consistency, maintainability, and best practices across all our repositories.
+If you do not already have Java 21 installed, you will need to install it. There are many ways to do this, but a recommended approach
+is to use [jenv](https://github.com/jenv/jenv) to manage your local Java versions and enable easy switching between them. jenv will
+also automatically switch to use the correct Java version when you navigate to a project containing a `.java-version` file (providing
+it is already installed).
 
-You can find the standards [here](https://github-community.service.justice.gov.uk/repository-standards/guidance).
+```sh
+# Check your current Java version - if it is Java 21 then the rest of the following steps are optional
+java -version
 
-Please read and understand these standards thoroughly and enable them when you feel comfortable.
+brew update
 
-### Modify the GitHub Standards Badge
+brew install jenv
+brew install openjdk@21
 
-Once you've ensured that all the [GitHub Repository Standards](https://github-community.service.justice.gov.uk/repository-standards/guidance) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README file.
+# See the output from the previous command to determine where Java 21 was installed
+# You may need to symlink to your JavaVirtualMachines directory from the installed location to be able to use it
+jenv add /path/to/Java/Contents/Home
 
-The badge demonstrates that your repository is compliant with MoJ's standards.
+# Check to ensure that you can see Java 21 now listed
+jenv versions
 
-To update the badge, replace the `template-repository` in the badge URL with your repository's name. The badge URL should look like this:
+# Switch to Java 21 (ensure you're still inside the laa-crime-assessment-service directory)
+jenv local 21
 
-```markdown
-[![Ministry of Justice Repository Compliance Badge](https://github-community.service.justice.gov.uk/repository-standards/api/${your-repository-name}/badge)](https://github-community.service.justice.gov.uk/repository-standards/${your-reposistory-name})
+# Confirm that Java 21 is now the current Java version
+java -version
 ```
 
-**Please note** the badge will not function correctly if your repository is internal or private. In this case, you may remove the badge from your README.
-
-### Update CODEOWNERS
+### Running tests
 
-(Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests.
+Make sure tests all testes are passed by running following ‘gradle’ Command
path: README.md
user: login: sophiebrown01
body: Done
created_at: 2025-05-14T14:20:53Z
author_association: COLLABORATOR

PR comments:
user: login: Mhowell494
created_at: 2025-05-14T12:04:08Z
body: Looks good! Could we also add the CodeQL workflow we use in our other repositories? The code formatter can be ignored for now, as it doesn't appear to do anything — we should probably look at removing it from our other repos too.
author_association: CONTRIBUTOR
user: login: sophiebrown01
created_at: 2025-05-14T14:21:27Z
body: > Looks good! Could we also add the CodeQL workflow we use in our other repositories? The code formatter can be ignored for now, as it doesn't appear to do anything — we should probably look at removing it from our other repos too.

Thanks, CodeQL workflow now added but currently failing because there isn't any code for it to run against (yet!).
author_association: COLLABORATOR
user: login: sophiebrown01
created_at: 2025-05-14T15:41:54Z
body: > LG2M — thanks for adding the PR checks too, I'd forgotten about this

I've removed the PR checks as discussed, as I didn't mean to push them in this PR.
author_association: COLLABORATOR