This page describes some common conventions and patterns that we follow in our GitHub repositories.
Documentation¶
The Team Compass is built with the MyST Document Engine. Many other 2i2c repositories build their documentation with the Sphinx documentation engine and a shared Sphinx theme instead, to standardize the look and feel of our docs and provide cross-references and navigation links across sites.
Issue templates¶
We use Issue Templates to provide helpful prompts for common issues across all of our repositories.
These templates live in our .github/ repository and are automatically synchronized with several other repositories with this GitHub Workflow.
When you update one of the issue templates in that repository, a PR will automatically be created for the other repositories that are defined in the sync.yml file.