template.github.platform 🍻

This repository is for experimentation and examples of how to use GitHub features.

• template.github.platform 🍻
  • Github Status
  • Repo Insights
  • README Examples
  • Work Item Template Examples
  • Markdown
  • Automation
  • Developer Environments
  • Discussions
  • Wiki
  • Projects
  • Security
    • .gitgnore Examples
    • Policy
    • Codeowners
    • Automation

Github Status

• Github Status - Remember to check the status of github before you start working on anything. This will help you understand if any issues you are experiencing are due to github or your own setup.

Repo Insights

• Insights - Remember to use the insights tab and look through your repo to ensure you meet community standards and keep an eye on dependencies among other things.

README Examples

• Awesome Readme

Work Item Template Examples

• Hungovercoder Templates - Currently it appears only the yaml base templates allow for automatic linking projects to the issue. This is why have the add to project to cover non-template raised issues (such as mobile app).
• Awesome Github Templates

Markdown

• Hungovercoders Cheatsheet - This is a simple cheatsheet for markdown.
• Markdown Guide

Automation

• Actions - All automation from this repo can be found under its actions tab. There is a dedicated README here too which was done for the github actions cert.
• Hello World - This is the simplest github action workflow that allows for a base understanding of how they work.
• Add to Project - This workflow adds a new issue to a project board when a new issue is created. It leverages a user PAT token embedded as a github organisation secret that has issue and project write permissions only. It also references an organisation wide github variable to reference the project.
• Github Scripts - Octokit JS - Can leverage github script in actions e.g. github-script.yaml
• Github Scripts -Rest API

Developer Environments

• Github Dev - By changing any github repo URL to github.dev/{organisation}/{repo} instead of github.com/{organisation}/{repo} you get a light browser IDE to make text chamges easy. You wouldn't use this for real development as it can't run code etc but it is a quick way of updating markdown for example.
• Gitpod
• Github Codespaces

Discussions

• Discussions - Remember the discussions tab is a great place to have conversations and gather feedback on the repo that can link to future issues etc.

Wiki

• Wiki - Remember the wiki tab might be a better place for deep documentation so that you can keep the README more digestible!

Projects

• Projects - Don't forget to utilise projects for work management and link your codebase to one to make it easily accessible. This doesn't mean every issue magically appears there though currently and you'll need to setup some automation either via work item templates, automation in the project itself, or cover yourself with the Add to Project workflow in this repo.

• Inner Source

• Github Inner Source Guide

Security

.gitgnore Examples

• Git Ignore Examples

Policy

• Security Policy - This is maintanied by SECURITY.md file in the root of the repository. It is a good idea to have a security policy in place to ensure that any security issues are reported to the correct people.

Codeowners

• Hungovercoders Codeowners - This is a simple example of how to use codeowners to automatically assign reviewers to pull requests. It also shows how to use a wildcard to assign a team to a folder.
• About Codeowners

Automation

• Security Analysis - Consider enabling and automating dependabot alerts and security updates. This will ensure that any security issues are automatically raised as issues and pull requests.