Project template

This is a template to serve as a starting point for new repos.

Features

• Pre-configured CI/CD pipeline that runs pre-commit and ensures that the devcontainer builds successfully.
• A basic devcontainer setup
• Mergify configuration to enable merging of PRs. See .github/mergify.yml for details.
• Renovate configuration to keep dependencies up to date. See .github/renovate.json5 for details.
• Pre-commit configuration to ensure code quality. See .pre-commit-config.yaml for details.

New project checklist

• Adjust the Mergify configuration to customize the merge conditions
  • Consider enabling Merge protections to enable Depends-On: <PR#>, Merge-After: <ISO 8601>.
  • Consider enforcing the merge queue (only allowing Mergify to merge PRs) by protecting the default branch.
• Add a license to the project
• Update the README with project-specific information
• Update the devcontainer configuration based on the project's language and dev tools
• Update the AGENTS.md with project-specific information

AI Instructions Auto-Update Script

This repository includes a script to update AI instruction files from the upstream template repository, merging with local changes.

Usage

.github/update-instructions.sh \
  # Run update (modifies files)
.github/update-instructions.sh --dry-run \
  # Preview changes only (no files are modified)

The script will fetch the latest versions of:

• .claude/skills
• .github/instructions
• AGENTS.md

For each file, a three-way merge is performed between your local version, the base, and upstream. If a conflict occurs, a .merged file is created for manual resolution. All actions are logged to the console. The script can be run from any directory in the repository.

Resolving Conflicts

If you see a message like CONFLICT in <file>. See <file>.merged for manual resolution., open the .merged file, resolve the conflict markers (<<<<<<<, =======, >>>>>>>), and replace the original file with the resolved version.