Skip to content

Commit 2c0e787

Browse files
⚙️ setup: add Clean Commit convention with AGENTS.md and Copilot instructions (#38)
* Initial plan * ⚙️ setup: add Clean Commit convention with AGENTS.md and Copilot instructions Co-authored-by: warengonzaga <15052701+warengonzaga@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: warengonzaga <15052701+warengonzaga@users.noreply.github.com>
1 parent 5b73f9d commit 2c0e787

2 files changed

Lines changed: 94 additions & 0 deletions

File tree

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
applyTo: "**"
3+
---
4+
5+
# Clean Commit Workflow
6+
7+
This repository follows the **Clean Commit** workflow for all commit messages.
8+
9+
Reference: https://github.com/wgtechlabs/clean-commit
10+
11+
## Commit Message Format
12+
13+
```text
14+
<emoji> <type>: <description>
15+
<emoji> <type> (<scope>): <description>
16+
```
17+
18+
## The 9 Types
19+
20+
| Emoji | Type | What it covers |
21+
|:-----:|------|----------------|
22+
| 📦 | `new` | Adding new features, files, or capabilities |
23+
| 🔧 | `update` | Changing existing code, refactoring, improvements |
24+
| 🗑️ | `remove` | Removing code, files, features, or dependencies |
25+
| 🔒 | `security` | Security fixes, patches, vulnerability resolutions |
26+
| ⚙️ | `setup` | Project configs, CI/CD, tooling, build systems |
27+
|| `chore` | Maintenance tasks, dependency updates, housekeeping |
28+
| 🧪 | `test` | Adding, updating, or fixing tests |
29+
| 📖 | `docs` | Documentation changes and updates |
30+
| 🚀 | `release` | Version releases and release preparation |
31+
32+
## Rules
33+
34+
- Use lowercase for type
35+
- Use present tense ("add" not "added")
36+
- No period at the end
37+
- Keep description under 72 characters
38+
39+
## Examples
40+
41+
- `📦 new: user authentication system`
42+
- `🔧 update (api): improve error handling`
43+
- `🗑️ remove (deps): unused lodash dependency`
44+
- `🔒 security: patch XSS vulnerability`
45+
- `⚙️ setup: add eslint configuration`
46+
- `☕ chore: update npm dependencies`
47+
- `🧪 test: add unit tests for auth service`
48+
- `📖 docs: update installation instructions`
49+
- `🚀 release: version 1.0.0`

AGENTS.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Clean Commit Workflow
2+
3+
When generating commit messages for this repository, follow the **Clean Commit** workflow.
4+
5+
Reference: https://github.com/wgtechlabs/clean-commit
6+
7+
## Format
8+
9+
```text
10+
<emoji> <type>: <description>
11+
<emoji> <type> (<scope>): <description>
12+
```
13+
14+
## The 9 Types
15+
16+
| Emoji | Type | What it covers |
17+
|:-----:|------|----------------|
18+
| 📦 | `new` | Adding new features, files, or capabilities |
19+
| 🔧 | `update` | Changing existing code, refactoring, improvements |
20+
| 🗑️ | `remove` | Removing code, files, features, or dependencies |
21+
| 🔒 | `security` | Security fixes, patches, vulnerability resolutions |
22+
| ⚙️ | `setup` | Project configs, CI/CD, tooling, build systems |
23+
|| `chore` | Maintenance tasks, dependency updates, housekeeping |
24+
| 🧪 | `test` | Adding, updating, or fixing tests |
25+
| 📖 | `docs` | Documentation changes and updates |
26+
| 🚀 | `release` | Version releases and release preparation |
27+
28+
## Rules
29+
30+
- Use lowercase for type
31+
- Use present tense ("add" not "added")
32+
- No period at the end
33+
- Keep description under 72 characters
34+
35+
## Examples
36+
37+
- `📦 new: user authentication system`
38+
- `🔧 update (api): improve error handling`
39+
- `🗑️ remove (deps): unused lodash dependency`
40+
- `🔒 security: patch XSS vulnerability`
41+
- `⚙️ setup: add eslint configuration`
42+
- `☕ chore: update npm dependencies`
43+
- `🧪 test: add unit tests for auth service`
44+
- `📖 docs: update installation instructions`
45+
- `🚀 release: version 1.0.0`

0 commit comments

Comments
 (0)