Agentic Template

代理模板

 

AI优先开发的入门模板。支架 AGENTS.md, CLAUDE.md, CHANGELOG，以及 README 因此，像Claude Code、Cursor和Copilot这样的编码代理从第一天起就具有正确的上下文。

快速开始

点击 使用此模板 在GitHub上，或：

gh repo create my-project --template greynewell/agentic-template --clone

包含什么

运作原理

CLAUDE.md 是Claude Code在进入项目时读取的第一个文件。它指向 AGENTS.md，其中包含任何AI编码代理都应该遵循的规则——变更日志规则、提交约定、代码风格期望和PR要求。

这 构建工作流 强制执行结构：必需的文件必须存在，更改日志必须具有 [Unreleased] 部分，以及 CLAUDE.md 必须引用 AGENTS.md这使得代理和人类从第一次提交开始就保持一致。

自定义

使用此模板创建仓库后：

1. README.md --将占位符部分替换为项目的名称、描述、架构和构建命令
2. AGENTS.md --添加特定于项目的规则（语言约定、测试要求、部署约束）
3. CHANGELOG.md --开始记录以下更改 [Unreleased]
4. .github/workflows/build.yml --使用实际的构建、测试和部署步骤进行扩展

README模板

包含的README遵循一个为可扫描性而设计的一致结构：

# project-name         <- Name
[badges]               <- Status at a glance
[one-liner]            <- What it does

## Quick Start          <- How to use it in 3 commands
## Architecture         <- Mermaid diagram + explanation
## Features             <- Bullet list
## Development          <- Prerequisites, build, test
## Contributing         <- Fork/branch/PR workflow
## Roadmap              <- Link to project board
## Documentation        <- Links to docs
## License              <- License
[footer]               <- Site link, author

贡献

1. 分叉存储库
2. 创建要素分支
3. 进行更改
4. 提交拉取请求

许可证

麻省理工学院

______________________________________________________________________

由...创建 格雷·纽厄尔