This repository attempts to demonstrate how colleagues can implement the GitHub Policy (Link to internal site, not accessible externally) created by ONS' Software Engineering Community.
The wiki explains how you could implement the GitHub Repository policy.
DO NOT FORK this repository. Instead, use the Use this template feature.
To get started with this template:
- Click on Use this template.
- Select the correct visibility, default is public or internal over private. The default is internal as per GitHubs Documentation
- Name your new repository and provide a description, then click Create repository. Note: the repository name
should be lowercase and use
hyphens (
-) instead of spaces. - GitHub Actions will process the template and commit to your new repository shortly after you click Create repository.. Wait until the first run of GitHub Actions CI to finish!
- Once the Rename Project CI action has run, clone the repository and start working on your project.
NOTE: WAIT until first CI run of Rename Project job before cloning your new project.
Familiarise yourself with the ONS GitHub Policy and ensure your repository is compliant with the policy.
Few key points to note are:
- Branch Protection: Ensure
the
mainor any other primary branch is protected. - Signed Commits: Use GPG keys to sign your commits.
- Security Alerts: Make use of Secret scanning and Dependabot alerts.
- PIRR: If not public then ensure a PIRR.md is documented.
Please see CONTRIBUTING.md
- Title formatted as heading one.
- Brief Description of the Repository under said title.
- As many badges as possible.
- A link to a contributions page commonly called CONTRIBUTING.md.
- Table of contents.
- The basics, how to install or run the code within.
- At least one diagrams or video to show how the project works.