|
1 | | -# Ministry of Justice Template Repository |
| 1 | +# Analytical Platform Visual Studio Code |
2 | 2 |
|
3 | 3 | [](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/public-report/template-repository) |
4 | 4 |
|
5 | | -This template repository equips you with the default initial files required for a Ministry of Justice GitHub repository. |
| 5 | +This repository contains the Visual Studio Code Docker image for use in the Analytical Platform. |
6 | 6 |
|
7 | | -## Included Files |
| 7 | +This repository is managed in Terraform [here](https://github.com/ministryofjustice/data-platform/blob/2892887765f695e7690186dc33a989097fbdc59a/terraform/github/analytical-platform-repositories.tf#L286). |
8 | 8 |
|
9 | | -The repository comes with the following preset files: |
| 9 | +## Features |
10 | 10 |
|
11 | | -- LICENSE |
12 | | -- .gitignore |
13 | | -- CODEOWNERS |
14 | | -- dependabot.yml |
15 | | -- GitHub Actions example file |
16 | | -- Ministry of Justice Compliance Badge (Public repositories only) |
| 11 | +The base container image is [Ubuntu](https://hub.docker.com/_/ubuntu), as such the container comes with all of the built-in Ubuntu tools. |
17 | 12 |
|
18 | | -## Setup Instructions |
| 13 | +Additionally the following tools are installed: |
19 | 14 |
|
20 | | -Once you've created your repository using this template, ensure the following steps: |
21 | | - |
22 | | -### Update README |
23 | | - |
24 | | -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. |
25 | | - |
26 | | -### Update repository description |
27 | | - |
28 | | -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. |
29 | | - |
30 | | -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. |
31 | | - |
32 | | -### Grant Team Permissions |
33 | | - |
34 | | -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. |
35 | | - |
36 | | -### Read about the GitHub repository standards |
37 | | - |
38 | | -Familiarise yourself with the Ministry of Justice GitHub Repository Standards. These standards ensure consistency, maintainability, and best practices across all our repositories. |
39 | | - |
40 | | -You can find the standards [here](https://operations-engineering.service.justice.gov.uk/documentation/services/repository-standards.html). |
41 | | - |
42 | | -Please read and understand these standards thoroughly and enable them when you feel comfortable. |
43 | | - |
44 | | -### Modify the GitHub Standards Badge |
45 | | - |
46 | | -Once you've ensured that all the [GitHub Repository Standards](https://operations-engineering.service.justice.gov.uk/documentation/services/repository-standards.html) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README file. |
47 | | - |
48 | | -The badge demonstrates that your repository is compliant with MoJ's standards. Please follow these [instructions](https://operations-engineering.service.justice.gov.uk/documentation/runbooks/services/add-repo-badge.html) to modify the badge URL to reflect the status of your repository correctly. |
49 | | - |
50 | | -**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. |
51 | | - |
52 | | -### Manage Outside Collaborators |
53 | | - |
54 | | -To add an Outside Collaborator to the repository, follow the guidelines detailed [here](https://github.com/ministryofjustice/github-collaborators). |
55 | | - |
56 | | -### Update CODEOWNERS |
57 | | - |
58 | | -(Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests. |
59 | | - |
60 | | -### Configure Dependabot |
61 | | - |
62 | | -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). |
63 | | - |
64 | | -If your repository is private with no GitHub Advanced Security license, remove the .github/workflows/dependency-review.yml file. |
| 15 | +- [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/index.html) |
| 16 | +- [Miniconda](https://docs.anaconda.com/free/miniconda/index.html) |
0 commit comments