Version: 1.0.0
Last updated: 2025-11-27
This repository is a starter layout for AI-augmented / agentic workflows.
It gives you:
- A clear place for agents and their instructions.
- A space for repo-specific vision and guidelines.
- Separate areas for work-in-progress and generated output.
For further tips and tricks on using AI agents in your projects, take a look at:
- Augmented Coding Patterns by @lexler
- the Agents.md specification
- Agent Framework Glossary for standardized terminology definitions
When you attach an AI assistant to this repository, you can instruct it to:
- Read
.github/agents/bootstrap.mdfirst. - Tell you when it's ready to start working.
- Proceed with your instructions.
- Use
work/for:- progress logs
- design notes
- coordination messages to other agents
- Write any generated artifacts (code, documents, reports) to
output/. - Never directly modify
docs/without human approval.
This keeps intent (docs/), collaboration (work/), and artifacts (output/) clearly separated.
REPLACE THIS SECTION with project-specific flows.
- Design agent writes initial plans to
work/design-notes.md. - Builder agent generates code into
output/. - Human reviews and promotes files from
output/into tracked source directories.
You can use the specialist agents in .github/agents/ as a starting point. On github, you can start tasks by using the 'agents panel' (top-right icon) or by assigning a GitHub issue to a specific agent.
- Define your intent Edit:
- Adjust the agents
- Read
.github/agents/QUICKSTART.md. - Review the generic guidelines in
.github/agents/general_guidelines.md. - Keep, rename, or remove specialist agents in
.github/agents/*.agent.md.
- Read
- Use the shared spaces
- This repo is designed to be adapted. Feel free to modify the structure as needed.
- By default, everything in work/ is tracked.
You can adjust
.gitignoreif you want a more ephemeral scratch space.
REPLACE THIS README WHEN READY! Use this README as a template to create your own project README.
