Skip to content

Commit 6b60d16

Browse files
CopilotMossaka
andauthored
docs: remove duplicate 'what's changed' heading in release template (#50)
* Initial plan * docs: fix duplicate "what's changed" heading in release notes Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com> * docs: add conventional commit guidelines to agents.md Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com> * docs: clarify scope is optional in commit format Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com> * docs: clarify header max length in commit format Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com> * ci: remove commitlint workflow Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
1 parent fbc9744 commit 6b60d16

File tree

3 files changed

+30
-26
lines changed

3 files changed

+30
-26
lines changed

.github/workflows/commitlint.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

AGENTS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,36 @@ This downloads artifacts to `./artifacts-run-$RUN_ID` for local examination. Req
7575

7676
**Example:** The "Pool overlaps" Docker network error was reproduced locally, traced to orphaned networks from `timeout`-killed processes, fixed by adding pre-test cleanup in scripts, then verified before updating workflows.
7777

78+
### Commit Message Format
79+
80+
**IMPORTANT:** This repository enforces [Conventional Commits](https://www.conventionalcommits.org/) via commitlint and husky hooks.
81+
82+
**Format:** `type(scope): subject` (scope is optional)
83+
84+
**Rules:**
85+
- `type` and `subject` must be lowercase
86+
- No period at end of subject
87+
- Header (entire commit message first line) max 72 characters
88+
- `scope` is optional but can help clarify the area of change
89+
- Both commit messages AND PR titles must follow this format
90+
91+
**Common types:**
92+
- `feat`: New feature
93+
- `fix`: Bug fix
94+
- `docs`: Documentation changes
95+
- `chore`: Maintenance tasks
96+
- `test`: Test changes
97+
- `refactor`: Code refactoring
98+
- `ci`: CI/CD changes
99+
100+
**Examples:**
101+
- ✅ `docs: fix duplicate heading in release template`
102+
- ✅ `docs(template): fix duplicate heading in release template`
103+
- ✅ `feat: add new domain whitelist option`
104+
- ✅ `fix(cleanup): resolve container cleanup race condition`
105+
- ❌ `Fix bug` (missing type)
106+
- ❌ `docs: Fix template.` (uppercase subject, period at end)
107+
78108
## Development Commands
79109

80110
### Build and Testing

docs/RELEASE_TEMPLATE.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ Everything below the `---` separator becomes the release notes.
1919

2020
---
2121

22-
## What's Changed
23-
2422
{{CHANGELOG}}
2523

2624
## CLI Options

0 commit comments

Comments
 (0)