This template repository equips you with the default initial files required for a Ministry of Justice GitHub repository.
The repository comes with the following preset files:
- LICENSE
- .gitignore
- CODEOWNERS
- dependabot.yml
- GitHub Actions example file
- Ministry of Justice Compliance Badge (Public repositories only)
Once you've created your repository using this template, ensure the following steps:
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.
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.
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.
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.
Please read and understand these standards thoroughly and enable them when you feel comfortable.
Once you've ensured that all the GitHub Repository Standards 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 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.
To add an Outside Collaborator to the repository, follow the guidelines detailed here.
(Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests.
Adapt the dependabot.yml file to match your project's dependency manager and to enable automated pull requests for package updates.
If your repository is private with no GitHub Advanced Security license, remove the .github/workflows/dependency-review.yml file.
# Install pipenv via brew
brew install pipenv
# or via pip
python3 -m pip install pipenv
# Install all dependencies, including development dependencies
pipenv install --dev
# Run a script within the created virtual environment
pipenv run tests
# or as a command
pipenv run coverage run python -m unittest
# Get location of virtual environment (location may be needed to point your IDE to the right interpreter)
pipenv --venv
# Check for vulnerable packages
pipenv check
# Additional information on pipenv functionality
pipenv --help