Skip to content

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

AI-Assisted Development Templates

This repository holds Markdown templates, a Git commit-message template, and a Claude Code settings template for projects that use AI in software development or research. The companion AI-Assisted Development Guideline will be published separately on the author's Jekyll website and its public link will be added here when available.

Template files

File Use in an adopting project
AGENTS-template.md Adapt as AGENTS.md for coding agents.
AI-POLICY-template.md Adapt as AI-POLICY.md for contributors.
AI-DISCLOSURE-template.md Adapt as a disclosure for a specific research output.
README-ai-section-template.md Add an AI section to the project's README.md.
CONTRIBUTING-ai-section-template.md Add a section to CONTRIBUTING.md; its second block fits an existing PR template.
CONTRIBUTING-names-section-template.md Add a "Names" section to CONTRIBUTING.md: the type and area lists.
pull-request-template.md Use as a complete .github/pull_request_template.md when needed.
SKILL-create-branch-template.md Copy to .agents/skills/create-branch/SKILL.md.
SKILL-write-test-template.md Copy to .agents/skills/write-test/SKILL.md; add the framework's rules.
SKILL-write-commit-template.md Copy to .agents/skills/write-commit/SKILL.md.
SKILL-open-pull-request-template.md Copy to .agents/skills/open-pull-request/SKILL.md.
SKILL-open-issue-template.md Copy to .agents/skills/open-issue/SKILL.md.
SKILL-post-comment-template.md Copy to .agents/skills/post-comment/SKILL.md.
SKILL-draft-release-template.md Copy to .agents/skills/draft-release/SKILL.md; a person invokes it.
gitmessage-template.txt Copy to .gitmessage and adapt the commit convention.
claude-settings-template.json Copy to .claude/settings.json for Claude Code.

The two PR options serve different starting points: add the short AI block to an existing PR template, or copy the complete PR template. Use one AI prompt in the resulting PR form.

The templates are written in Canadian English, for example "licence" as a noun, "behaviour", and "colour". An adopting repository may keep that spelling or change it to its own, but keeps one spelling throughout.

.gitmessage is this repository's own commit-message example. To use a copied .gitmessage for editor-based commits, run git config commit.template .gitmessage in that project. Git does not apply it to git commit -m; check the final message for completed provenance trailers.

scripts/check-names.sh checks that an adopting repository's labels, .gitmessage, skills, and templates agree with its CONTRIBUTING.md, "Names"; it reads the labels with gh and changes nothing. With --print-label-commands it prints the gh label commands to run, and renames an old label such as bug to type:fix rather than creating a new one, which keeps it on its issues; --rename <old>=<new> adds a pair.

Scope

The skills and tools assume GitHub and the gh CLI. The tools are POSIX sh scripts that call standard utilities and git; check-names.sh and check-repo-settings.sh call gh unless given --labels or --file. A GitLab project would change the commands (glab) and the terms (merge request), and the set does not cover that yet. The draft-release skill writes changelog sections in Common Changelog form: unlike Keep a Changelog, there is no Unreleased section, each section is written at release time, and every line references a commit or pull request.

AI assistance

I use AI tools in this project. Each part has a tier, set by whether I can evaluate AI output there. The table records the checks or human review applied to each part:

  • Instrumented — I could write it myself. AI is used for review, refactoring, and alternative implementations, not first drafts of core logic.
  • Supervised — AI drafts; I read every line and set the acceptance criteria and test values.
  • Delegated — AI generates; I can't fully evaluate it. It is covered by tests, kept isolated and low-risk, and not presented as my work.
Part Tier Checks or human review
Stored templates, README.md Instrumented I design and write the first draft of each file; AI revises; I review every line and finalize wording.
Issues, pull requests, commit messages Instrumented AI drafts at my request; I review each before it is posted or merged.
.gitmessage, .gitignore, .github/ Instrumented AI writes at my request; I review the diff in a pull request.
scripts/, .githooks/, tests/ Supervised AI drafts against acceptance criteria I set in the issues; I read every line, and ShellCheck and each script's passing and failing fixtures must pass before I merge.
AGENTS.md, CLAUDE.md, .claude/, LICENSE Instrumented AI drafts each change as a patch in the pull request; I apply, review, and commit it myself.

Where a tier is unclear, I treat the part as Supervised. Tiers last reviewed: 2026-10-09.

Instructions for AI agents: AGENTS.md.

Licence

This repository, the templates and tools included, is licensed under the MIT License.

Status

These are adaptable templates. Replace or remove every placeholder and check each statement against the adopting project's actual practice before use.

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages