generated from ministryofjustice/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,16 @@ | ||
| # Ministry of Justice Template Repository | ||
| # Analytical Platform Visual Studio Code | ||
|
|
||
| [](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/public-report/template-repository) | ||
|
|
||
| This template repository equips you with the default initial files required for a Ministry of Justice GitHub repository. | ||
| This repository contains the Visual Studio Code Docker image for use in the Analytical Platform. | ||
|
|
||
| ## Included Files | ||
| This repository is managed in Terraform [here](https://github.com/ministryofjustice/data-platform/blob/2892887765f695e7690186dc33a989097fbdc59a/terraform/github/analytical-platform-repositories.tf#L286). | ||
|
|
||
| The repository comes with the following preset files: | ||
| ## Features | ||
|
|
||
| - LICENSE | ||
| - .gitignore | ||
| - CODEOWNERS | ||
| - dependabot.yml | ||
| - GitHub Actions example file | ||
| - Ministry of Justice Compliance Badge (Public repositories only) | ||
| The base container image is [Ubuntu](https://hub.docker.com/_/ubuntu), as such the container comes with all of the built-in Ubuntu tools. | ||
|
|
||
| ## Setup Instructions | ||
| Additionally the following tools are installed: | ||
|
|
||
| Once you've created your repository using this template, ensure the following steps: | ||
|
|
||
| ### 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. | ||
|
|
||
| ### Read about the GitHub repository standards | ||
|
|
||
| Familiarise yourself with the Ministry of Justice GitHub Repository Standards. These standards ensure consistency, maintainability, and best practices across all our repositories. | ||
|
|
||
| You can find the standards [here](https://operations-engineering.service.justice.gov.uk/documentation/services/repository-standards.html). | ||
|
|
||
| Please read and understand these standards thoroughly and enable them when you feel comfortable. | ||
|
|
||
| ### Modify the GitHub Standards Badge | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| **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. | ||
|
|
||
| ### Manage Outside Collaborators | ||
|
|
||
| To add an Outside Collaborator to the repository, follow the guidelines detailed [here](https://github.com/ministryofjustice/github-collaborators). | ||
|
|
||
| ### Update CODEOWNERS | ||
|
|
||
| (Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests. | ||
|
|
||
| ### Configure Dependabot | ||
|
|
||
| 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). | ||
|
|
||
| If your repository is private with no GitHub Advanced Security license, remove the .github/workflows/dependency-review.yml file. | ||
| - [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/index.html) | ||
| - [Miniconda](https://docs.anaconda.com/free/miniconda/index.html) |