Template

A general-purpose, agentic, language-agnostic repository template with sensible defaults for documentation, contribution guidelines, CI/CD, and AI agent configuration.

Features

• 📝 Contribution guidelines - CONTRIBUTING.md for humans and AI agents alike
• 🤖 AI agent support - AGENTS.md with a three-tier boundary framework, plus symlinks for Claude, Gemini, and Copilot instructions
• 🛠️ Slash commands - .claude/commands/ with an example code review command
• 🌿 Branching conventions - lightweight defaults for short-lived branches targeting main
• 🧪 Testing standards - AAA pattern, naming conventions, coverage expectations
• 🔒 Security posture - SECURITY.md with vulnerability reporting process
• 📐 ADR framework - doc/adr/ for architectural decision records
• ⚙️ CI/CD starter - GitHub Actions workflow template
• 🧹 Editor consistency - .editorconfig for cross-editor formatting
• 📦 Dependabot - automated dependency update configuration

Getting Started

1. Click "Use this template" to create a new repository.
2. Fill in the Boundaries, Commands, Code Style, Non-Obvious Patterns, and Key Files sections in AGENTS.md. These drive the quality of AI-assisted contributions.
3. Customize or remove .claude/commands/review.md and .github/agents/example.md to fit your workflow.
4. Customize .github/workflows/ci.yml, then enable push / pull_request triggers for your branches.
5. Replace SECURITY.md with a real reporting channel before publishing the repository.
6. Replace the LICENSE if MIT is not appropriate.
7. Fill in this README.md with your project details.

Repository Structure

├── .claude/
│   └── commands/
│       └── review.md              # Example slash command (code review)
├── .editorconfig                  # Editor formatting rules
├── .gitignore                     # Common ignore patterns
├── .github/
│   ├── agents/
│   │   └── example.md             # Example Copilot cloud agent profile
│   ├── copilot-instructions.md    # GitHub Copilot guidance
│   ├── dependabot.yml             # Dependency update config
│   ├── ISSUE_TEMPLATE/            # Bug report & feature request templates
│   ├── PULL_REQUEST_TEMPLATE.md   # PR checklist template
│   └── workflows/ci.yml           # Starter CI pipeline
├── AGENTS.md                      # AI agent instructions (boundary framework)
├── CLAUDE.md                      # Symlink -> AGENTS.md
├── CODE_OF_CONDUCT.md             # Community standards
├── CONTRIBUTING.md                # Contribution guide (humans & AI)
├── GEMINI.md                      # Symlink -> AGENTS.md
├── LICENSE                        # MIT License
├── README.md                      # This file
├── SECURITY.md                    # Vulnerability reporting
└── doc/adr/                       # Architectural Decision Records

Copilot Auto-Review

To automatically request a GitHub Copilot code review on every pull request:

1. Go to Settings -> Rules -> Rulesets -> New ruleset -> New branch ruleset.
2. Name the ruleset, set enforcement to Active, and add target branches.
3. Under Branch rules, enable Automatically request Copilot code review.
4. Click Create.

Requires Copilot code review to be enabled for the repository (Settings -> Copilot -> Code review).

Notes for Template Users

• The starter CI workflow is intentionally manual-only until you wire in real build, lint, and test commands.
• The .github/agents/ directory holds Copilot cloud agent profiles. Customize example.md or add your own.
• The .claude/commands/ directory holds slash commands for Claude Code. Add more commands as needed.
• This template defaults to short-lived branches targeting main. If you prefer Gitflow or another model, document it explicitly in README.md and CONTRIBUTING.md.

Contributing

See CONTRIBUTING.md for guidelines on commits, branching, code review, testing, and more.

License

This project is licensed under the MIT License.