📖 docs: restructure examples folder into copy-paste templates

[Copilot]

Restructures examples/ to contain only ready-to-use template files that users can directly copy into their projects, while consolidating all explanatory documentation into the main README.

Changes

• New templates in examples/:

  • copilot.instructions.md - GitHub Copilot custom instructions with frontmatter
  • AGENTS.md - Generic AI agent instructions for Codex, Claude, Cursor, Windsurf

• Deleted: examples/EXAMPLES.md (content merged into README)

• README.md additions:

  • "Real-World Examples" section with Web App, API, Library, CLI, Bot (Discord/Telegram), and GitHub Action examples
  • "AI Integration" section with curl-based installation commands and link to production implementation

• README.md cleanup:

  • Removed examples/EXAMPLES.md reference from "Learn More" section

Usage

# GitHub Copilot
mkdir -p .github/instructions
curl -o .github/instructions/copilot.instructions.md \
  https://raw.githubusercontent.com/wgtechlabs/clean-commit/main/examples/copilot.instructions.md

# Other AI agents
curl -o AGENTS.md \
  https://raw.githubusercontent.com/wgtechlabs/clean-commit/main/examples/AGENTS.md

Final Structure

# Documentation (root)
├── README.md (includes all merged examples)
├── SPECIFICATION.md
└── QUICK-REFERENCE.md

# Templates (examples/)
├── copilot.instructions.md
└── AGENTS.md

Original prompt

Summary

Restructure the examples/ folder to be a pure copy-paste resource for users, and merge the existing documentation into the root README.

Changes Required

1. Add new template files to examples/

examples/copilot.instructions.md - GitHub Copilot custom instructions template:

---
applyTo: "**"
---

# Clean Commit Convention

This repository follows the **Clean Commit** convention for all commit messages.

Reference: https://github.com/wgtechlabs/clean-commit

## Commit Message Format

\`\`\`text
<emoji> <type>: <description>
<emoji> <type>(<scope>): <description>
\`\`\`

## The 9 Types

| Emoji | Type | What it covers |
|:-----:|------|----------------|
| 📦 | `new` | Adding new features, files, or capabilities |
| 🔧 | `update` | Changing existing code, refactoring, improvements |
| 🗑️ | `remove` | Removing code, files, features, or dependencies |
| 🔒 | `security` | Security fixes, patches, vulnerability resolutions |
| ⚙️ | `setup` | Project configs, CI/CD, tooling, build systems |
| ☕ | `chore` | Maintenance tasks, dependency updates, housekeeping |
| 🧪 | `test` | Adding, updating, or fixing tests |
| 📖 | `docs` | Documentation changes and updates |
| 🚀 | `release` | Version releases and release preparation |

## Rules

- Use lowercase for type
- Use present tense ("add" not "added")
- No period at the end
- Keep description under 72 characters

## Examples

- `📦 new: user authentication system`
- `🔧 update(api): improve error handling`
- `🗑️ remove(deps): unused lodash dependency`
- `🔒 security: patch XSS vulnerability`
- `⚙️ setup: add eslint configuration`
- `☕ chore: update npm dependencies`
- `🧪 test: add unit tests for auth service`
- `📖 docs: update installation instructions`
- `🚀 release: version 1.0.0`

examples/AGENTS.md - AI agents template for Codex, Claude, Cursor, Windsurf, etc.:

# Clean Commit Convention

When generating commit messages for this repository, follow the **Clean Commit** convention.

Reference: https://github.com/wgtechlabs/clean-commit

## Format

\`\`\`text
<emoji> <type>: <description>
<emoji> <type>(<scope>): <description>
\`\`\`

## The 9 Types

| Emoji | Type | What it covers |
|:-----:|------|----------------|
| 📦 | `new` | Adding new features, files, or capabilities |
| 🔧 | `update` | Changing existing code, refactoring, improvements |
| 🗑️ | `remove` | Removing code, files, features, or dependencies |
| 🔒 | `security` | Security fixes, patches, vulnerability resolutions |
| ⚙️ | `setup` | Project configs, CI/CD, tooling, build systems |
| ☕ | `chore` | Maintenance tasks, dependency updates, housekeeping |
| 🧪 | `test` | Adding, updating, or fixing tests |
| 📖 | `docs` | Documentation changes and updates |
| 🚀 | `release` | Version releases and release preparation |

## Rules

- Use lowercase for type
- Use present tense ("add" not "added")
- No period at the end
- Keep description under 72 characters

## Examples

- `📦 new: user authentication system`
- `🔧 update(api): improve error handling`
- `🗑️ remove(deps): unused lodash dependency`
- `🔒 security: patch XSS vulnerability`
- `⚙️ setup: add eslint configuration`
- `☕ chore: update npm dependencies`
- `🧪 test: add unit tests for auth service`
- `📖 docs: update installation instructions`
- `🚀 release: version 1.0.0`

2. Delete examples/EXAMPLES.md

Remove this file as its content will be merged into the root README.

3. Update README.md

Add the following sections to the README (after the existing "GitHub Copilot Integration" section):

Add "Real-World Examples" section with content from EXAMPLES.md:

Include examples for:

• Web Application
• API / Backend
• Library / SDK
• CLI Tool
• Reference to SPECIFICATION.md for Bot and GitHub Action examples

Add "AI Integration" section:

## AI Integration

Copy these templates to integrate Clean Commit with AI coding assistants.

### GitHub Copilot

Copy [`examples/copilot.instructions.md`](examples/copilot.instructions.md) to your project:

\`\`\`bash
mkdir -p .github/instructions
curl -o .github/instructions/copilot.instructions.md https://raw.githubusercontent.com/wgtechlabs/clean-commit/main/examples/copilot.instructions.md
\`\`\`

### AI Agents (Codex, Claude, Cursor, Windsurf, etc.)

Copy [`examples/AGENTS.md`](examples/AGENTS.md) to your project root:

\`\`\`bash
curl -o AGENTS.md https://raw.githubusercontent.com/wgtechlabs/clean-commit/main/examples/AGENTS.md
\`\`\`

### Real-World Implementation

- [wgtechlabs/nuvex](https://github.com/wgtechlabs/nuvex/blob/main/.github/instructions/clean_commit.instructions.md)

Update "Learn More" section:

Remove the reference to examples/EXAMPLES.md since it will be deleted.

Final Structure

# Root (documentation)
README.md (main docs + merged EXAMPLES.md content)
SPECIFICATION.md
QUICK-REFERENCE.md
CONTRIBUTING.md
LICENSE

# Examples (copy-paste templates only)
examples/
├── copilot.instructions.md
└── AGEN...

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

*This pull request was created as a result of the following prompt from Copilot chat.*
> ## Summary
> 
> Restructure the `examples/` folder to be a pure copy-paste resource for users, and merge the existing documentation into the root README.
> 
> ## Changes Required
> 
> ### 1. Add new template files to `examples/`
> 
> **`examples/copilot.instructions.md`** - GitHub Copilot custom instructions template:
> 
> ```markdown
> ---
> applyTo: "**"
> ---
> 
> # Clean Commit Convention
> 
> This repository follows the **Clean Commit** convention for all commit messages.
> 
> Reference: https://github.com/wgtechlabs/clean-commit
> 
> ## Commit Message Format
> 
> \`\`\`text
> <emoji> <type>: <description>
> <emoji> <type>(<scope>): <description>
> \`\`\`
> 
> ## The 9 Types
> 
> | Emoji | Type | What it covers |
> |:-----:|------|----------------|
> | 📦 | `new` | Adding new features, files, or capabilities |
> | 🔧 | `update` | Changing existing code, refactoring, improvements |
> | 🗑️ | `remove` | Removing code, files, features, or dependencies |
> | 🔒 | `security` | Security fixes, patches, vulnerability resolutions |
> | ⚙️ | `setup` | Project configs, CI/CD, tooling, build systems |
> | ☕ | `chore` | Maintenance tasks, dependency updates, housekeeping |
> | 🧪 | `test` | Adding, updating, or fixing tests |
> | 📖 | `docs` | Documentation changes and updates |
> | 🚀 | `release` | Version releases and release preparation |
> 
> ## Rules
> 
> - Use lowercase for type
> - Use present tense ("add" not "added")
> - No period at the end
> - Keep description under 72 characters
> 
> ## Examples
> 
> - `📦 new: user authentication system`
> - `🔧 update(api): improve error handling`
> - `🗑️ remove(deps): unused lodash dependency`
> - `🔒 security: patch XSS vulnerability`
> - `⚙️ setup: add eslint configuration`
> - `☕ chore: update npm dependencies`
> - `🧪 test: add unit tests for auth service`
> - `📖 docs: update installation instructions`
> - `🚀 release: version 1.0.0`
> ```
> 
> **`examples/AGENTS.md`** - AI agents template for Codex, Claude, Cursor, Windsurf, etc.:
> 
> ```markdown
> # Clean Commit Convention
> 
> When generating commit messages for this repository, follow the **Clean Commit** convention.
> 
> Reference: https://github.com/wgtechlabs/clean-commit
> 
> ## Format
> 
> \`\`\`text
> <emoji> <type>: <description>
> <emoji> <type>(<scope>): <description>
> \`\`\`
> 
> ## The 9 Types
> 
> | Emoji | Type | What it covers |
> |:-----:|------|----------------|
> | 📦 | `new` | Adding new features, files, or capabilities |
> | 🔧 | `update` | Changing existing code, refactoring, improvements |
> | 🗑️ | `remove` | Removing code, files, features, or dependencies |
> | 🔒 | `security` | Security fixes, patches, vulnerability resolutions |
> | ⚙️ | `setup` | Project configs, CI/CD, tooling, build systems |
> | ☕ | `chore` | Maintenance tasks, dependency updates, housekeeping |
> | 🧪 | `test` | Adding, updating, or fixing tests |
> | 📖 | `docs` | Documentation changes and updates |
> | 🚀 | `release` | Version releases and release preparation |
> 
> ## Rules
> 
> - Use lowercase for type
> - Use present tense ("add" not "added")
> - No period at the end
> - Keep description under 72 characters
> 
> ## Examples
> 
> - `📦 new: user authentication system`
> - `🔧 update(api): improve error handling`
> - `🗑️ remove(deps): unused lodash dependency`
> - `🔒 security: patch XSS vulnerability`
> - `⚙️ setup: add eslint configuration`
> - `☕ chore: update npm dependencies`
> - `🧪 test: add unit tests for auth service`
> - `📖 docs: update installation instructions`
> - `🚀 release: version 1.0.0`
> ```
> 
> ### 2. Delete `examples/EXAMPLES.md`
> 
> Remove this file as its content will be merged into the root README.
> 
> ### 3. Update `README.md`
> 
> Add the following sections to the README (after the existing "GitHub Copilot Integration" section):
> 
> #### Add "Real-World Examples" section with content from EXAMPLES.md:
> 
> Include examples for:
> - Web Application
> - API / Backend
> - Library / SDK
> - CLI Tool
> - Reference to SPECIFICATION.md for Bot and GitHub Action examples
> 
> #### Add "AI Integration" section:
> 
> ```markdown
> ## AI Integration
> 
> Copy these templates to integrate Clean Commit with AI coding assistants.
> 
> ### GitHub Copilot
> 
> Copy [`examples/copilot.instructions.md`](examples/copilot.instructions.md) to your project:
> 
> \`\`\`bash
> mkdir -p .github/instructions
> curl -o .github/instructions/copilot.instructions.md https://raw.githubusercontent.com/wgtechlabs/clean-commit/main/examples/copilot.instructions.md
> \`\`\`
> 
> ### AI Agents (Codex, Claude, Cursor, Windsurf, etc.)
> 
> Copy [`examples/AGENTS.md`](examples/AGENTS.md) to your project root:
> 
> \`\`\`bash
> curl -o AGENTS.md https://raw.githubusercontent.com/wgtechlabs/clean-commit/main/examples/AGENTS.md
> \`\`\`
> 
> ### Real-World Implementation
> 
> - [wgtechlabs/nuvex](https://github.com/wgtechlabs/nuvex/blob/main/.github/instructions/clean_commit.instructions.md)
> ```
> 
> #### Update "Learn More" section:
> 
> Remove the reference to `examples/EXAMPLES.md` since it will be deleted.
> 
> ## Final Structure
> 
> ```
> # Root (documentation)
> README.md (main docs + merged EXAMPLES.md content)
> SPECIFICATION.md
> QUICK-REFERENCE.md
> CONTRIBUTING.md
> LICENSE
> 
> # Examples (copy-paste templates only)
> examples/
> ├── copilot.instructions.md
> └── AGENTS.md
> ```
> 
> ## Reference
> 
> This change was inspired by the implementation in [wgtechlabs/nuvex](https://github.com/wgtechlabs/nuvex/blob/main/.github/instructions/clean_commit.instructions.md).

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey).

[Copilot]

Pull request overview

This PR restructures the examples/ folder from a documentation-heavy approach into a collection of ready-to-use template files that users can directly copy into their projects. The explanatory documentation from examples/EXAMPLES.md is consolidated into the main README.md to create a single, comprehensive documentation source.

Key changes:

• Two new template files created for AI integration (GitHub Copilot and general AI agents)
• Comprehensive real-world examples integrated into README.md covering Web Apps, APIs, Libraries, and CLI tools
• New AI Integration section with curl-based installation commands
• Deletion of examples/EXAMPLES.md and removal of its reference from README.md

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
examples/copilot.instructions.md	New GitHub Copilot custom instructions template with frontmatter for easy copy-paste integration
examples/AGENTS.md	New generic AI agent instructions template for tools like Codex, Claude, Cursor, and Windsurf
examples/EXAMPLES.md	Deleted file containing examples that are now consolidated into README.md
README.md	Added comprehensive "Real-World Examples" and "AI Integration" sections; removed reference to deleted EXAMPLES.md

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[warengonzaga]

@copilot apply changes based on the comments in this thread