Use this template to create a repository with the default initial files for a Ministry of Justice Github repository, including:
- The correct LICENSE
- Github Action example
- A .gitignore file
- A CODEOWNERS file
- A dependabot.yml file
- The MoJ Compliant Badge (Public repositories only)
Once you have created your repository, please:
- Edit the copy of this README.md file to document your project.
- Grant permission/s to the appropriate MoJ team/s with at least one team having Admin permissions.
- Try not to add individual users to the repository, instead use a team.
- To add an Outside Collaborator to the repository follow the guidelines on the GitHub-collaborator repository.
- Ensure branch protection is set up on the main branch.
- [Optional] Modify the CODEOWNERS file and state the team or users that can authorise PR's.
- Modify the Dependabot file to suit the dependency manager you plan to use and for automated pull requests for package updates. Dependabot is enabled in the settings by default.
- Modify the short description found on the right side of the README.md file.
- Ensure as many of the GitHub Standards rules are maintained as possibly can.
- Modify the MoJ Compliant Badge url using these instructions. If the repository is internal or private then the badge can removed as it will not work.
- For a private repo with no GitHub Advanced Security license remove the .github/workflows/dependency-review.yml file.