repository-template

General-purpose repository template for the ISSL organization.

[Required] Configure CODEOWNERS

You must update .github/CODEOWNERS right after creating a repository from this template.

• Uncomment the default * line and replace @your-username with the actual owner — a real user (@person) or a team (@ut-issl/<team-slug>).

• Add path-specific overrides as needed, for example:

  .github/        @infra-manager
  docs/           @docs-manager
  

See the GitHub docs for the full syntax.

Pre-commit Setup

This template uses prek, a faster drop-in replacement for pre-commit.

prek install --hook-type pre-commit --hook-type pre-push

If you prefer pre-commit, substitute pre-commit for prek in the command above.

Opt-in Features

By default only lint-gh-actions (GitHub Actions workflow lint) and check-prek (runs the pre-commit hooks) run on PRs; everything else is disabled. Enable any of the below if you want them.

Additional CI Jobs

The following jobs are commented out in ci.yaml. Uncomment the corresponding block to enable each one. Each job runs only when the relevant files change.

• validate-renovate-config — validate the Renovate config
• lint-markdown — lint Markdown files
• lint-json5 — lint JSON5 files
• lint-toml — lint and format TOML files
• lint-yaml — lint YAML files
• check-typos — check for typos

Conventional Commits Enforcement (Commitizen)

Enforces Conventional Commits on commit messages and PR titles via commitizen. Once enabled, all commits and PR titles must follow the spec. Linting the PR title is especially useful with squash merging, since the PR title becomes the subject of the squashed commit by default.

Uncomment both blocks:

• lint-commit-messages in ci.yaml
• lint-pr-title in manage-pull-requests.yaml

To author Conventional Commits interactively:

uv tool install commitizen
cz commit

Renovate

Renovate is preconfigured in .github/renovate.json5 to track Action SHAs, pinned tool versions inside ci.yaml, and pre-commit hooks. To opt in, remove the enabled: false, line at renovate.json5#L3 (or change it to true) and make sure the Renovate GitHub App is installed for the repository.