Today I wanted to focus on a quick win for anyone who uses GitHub: a template repository for doing a bunch of cool GitHub things automatically.
tl;dr you can use solve-it-once/.github as a template repo to ensure your GitHub organization (or individual account) has a default version of all the markdown and yaml files that GitHub uses in its interface.
First things first: .github
can be the name of a special repository located within an account or organization, or it can be the name of a directory in any repository that contains the same or similar files to those in the solve-it-once example.
If an org has a .github repository, the markdown and yaml files within it are the default policies and templates for the whole organization. A .github/
directory within a particular repo in that org will override those defaults, so you can have a different code of conduct for one project while all the others use the default, for instance.
All the files in solve-it-once/.github are worded as generically as possible, so in many cases you don’t have to change a single thing… though you’re certainly welcome to!
To include a .github repository in your account or organization:
Of course, you can also tweak any of the other files as you desire, but those are the steps that will most appropriately make this exercise worthwhile.
You may already be familiar with .github directories in repositories, especially if you’ve used GitHub Actions that live in a workflows folder.
The solve-it-once/.github repo can be used as a guide/template for a repo directory, or — whether cloning the repo or downloading a release zip/tar file — can be copied and pasted into the root of your project.
The instructions for doing that are similar to the section above, with the following recommended changes:
Provisio Technology Solutions manages a lot of git projects on Patheon and Azure, but somewhat-recently started maintaining (private) forks on the Provisio GitHub org for redundancy, ability to navigate the code easier, and the Pull Request tooling for code reviews.
In the span of 20 minutes Solve it once was able to generate Provisio’s .github repo using the template repo button, tweak the profile readme, and enhance the company’s marketing presence on GitHub, which has the potential to open new avenues for clients to find them.
Any repository within the Provisio organization now falls back to the provided policy documents and templates, in case they are not provided for an individual repo.
Still here? Check out solve-it-once/.github for a helpful free head-start.