Skip to content

Commit b7d42cc

Browse files
Rename repository to GitHub AI Engineering Framework
- Updated README.md title and all references from 'AI Automation Template' to 'GitHub AI Engineering Framework' - Updated ASCII diagram with new framework name - Changed all 'template' references to 'framework' throughout README (12 instances) - Updated .gitignore header comment with new framework name - All pre-commit checks passing
1 parent 7157efc commit b7d42cc

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
###############################################################################
2-
# AI Automation Template - .gitignore
2+
# GitHub AI Engineering Framework - .gitignore
33
#
44
# This file follows the standards defined in docs/ai/CONTEXT.md
55
# Secrets, runtime artifacts, and generated files must never be committed.

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# 🤖 AI Automation Template
1+
# 🤖 GitHub AI Engineering Framework
22

33
<img src="https://chrispaquin.com/wp-content/uploads/2026/01/Nobby-the-robot.png" alt="Nobby the Robot" width="50%">
44

5-
> A **governance-first** GitHub Template for creating AI-assisted automation projects.
6-
> This template enforces security, documentation consistency, and quality through
5+
> A **governance-first** GitHub Framework for creating AI-assisted automation projects.
6+
> This framework enforces security, documentation consistency, and quality through
77
> automated checks and explicit AI agent instructions.
88
99
![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)
@@ -32,15 +32,15 @@
3232
## 🎯 Overview
3333

3434
This repository provides a structured foundation for AI-assisted development
35-
projects. Unlike traditional templates, this template treats
35+
projects. Unlike traditional templates, this framework treats
3636
**documentation as executable instructions** for AI agents. All AI tools
3737
(Cursor, ChatGPT, Copilot, etc.) are required to follow the standards
3838
defined in `docs/ai/CONTEXT.md`, making documentation the authoritative
3939
governance mechanism.
4040

4141
### Core Philosophy
4242

43-
**Governance through Documentation**: In this template, documentation serves
43+
**Governance through Documentation**: In this framework, documentation serves
4444
dual purposes:
4545

4646
-**Human-readable guidance** for developers and operators
@@ -57,7 +57,7 @@ across all AI-assisted development work.
5757

5858
### 1. Template Structure
5959

60-
When you use this template, you get:
60+
When you use this framework, you get:
6161

6262
| Component | Status | Description |
6363
|-----------|--------|-------------|
@@ -92,7 +92,7 @@ Governance is enforced through multiple layers:
9292

9393
### 🔐 Security Governance
9494

95-
Security is the **highest priority** in this template. All contributors and AI agents must adhere to strict security standards.
95+
Security is the **highest priority** in this framework. All contributors and AI agents must adhere to strict security standards.
9696

9797
#### Credentials and Secrets Management
9898

@@ -145,7 +145,7 @@ Documentation in this repository serves as **executable instructions** for AI ag
145145

146146
1.**Documentation Defines Behavior**: `docs/ai/CONTEXT.md` contains mandatory standards that AI agents must follow
147147
2.**Requirements Are Contracts**: `docs/requirements.md` defines the behavioral contract for the project
148-
3.**Consistency Is Enforced**: All projects using this template follow the same documentation structure
148+
3.**Consistency Is Enforced**: All projects using this framework follow the same documentation structure
149149
4.**AI Agents Are Accountable**: AI agents cannot deviate from documented standards without explicit clarification
150150

151151
#### Documentation Structure
@@ -200,7 +200,7 @@ Per `docs/ai/CONTEXT.md`, all projects must include:
200200

201201
```text
202202
┌─────────────────────────────────────────────────────────────────┐
203-
🤖 AI Automation Template
203+
🤖 GitHub AI Engineering Framework
204204
├─────────────────────────────────────────────────────────────────┤
205205
│ │
206206
│ ┌──────────────────────┐ ┌──────────────────────┐ │
@@ -237,9 +237,9 @@ Per `docs/ai/CONTEXT.md`, all projects must include:
237237

238238
## 🚀 Installation
239239

240-
### Step 1: Use This Template
240+
### Step 1: Use This Framework
241241

242-
- [ ] Click **"Use this template"** on GitHub to create a new repository from this template
242+
- [ ] Click **"Use this template"** on GitHub to create a new repository from this framework
243243

244244
### Step 2: Clone Your New Repository
245245

@@ -279,7 +279,7 @@ If you need to recreate the template structure:
279279

280280
## 🗑️ Uninstall Steps
281281

282-
To remove this template's infrastructure from a project:
282+
To remove this framework's infrastructure from a project:
283283

284284
### Step 1: Remove Pre-commit Hooks
285285

@@ -421,7 +421,7 @@ Markdown linting rules are configured in `.pymarkdown.json`:
421421

422422
### Security-First Design
423423

424-
This template is designed with security as the highest priority:
424+
This framework is designed with security as the highest priority:
425425

426426
| Security Feature | Status | Description |
427427
|-----------------|--------|-------------|
@@ -448,7 +448,7 @@ This template is designed with security as the highest priority:
448448

449449
### Reporting Security Issues
450450

451-
If you discover a security vulnerability in this template:
451+
If you discover a security vulnerability in this framework:
452452

453453
1.**Do not** open a public issue
454454
2. ✅ Contact the repository maintainers privately
@@ -478,7 +478,7 @@ Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for full
478478

479479
## 🤝 Contributing
480480

481-
When contributing to this template:
481+
When contributing to this framework:
482482

483483
- [x] Follow all standards in `docs/ai/CONTEXT.md`
484484
- [x] Ensure pre-commit passes: `./scripts/run-precommit.sh`

0 commit comments

Comments
 (0)