Skip to content

Commit baedd2c

Browse files
committed
docs: add CHANGELOG guidelines to CLAUDE.md
Document the CHANGELOG structure, entry format, and commit pattern for future contributors. Includes: - CHANGELOG sections (OCaml node, Added, Changed, Fixed, Dependencies) - Entry format with 80-character wrapping and PR references - Commit message pattern: 'CHANGELOG: add entry for patch XXXX' - Example entry from current PR This ensures consistent CHANGELOG maintenance across contributions.
1 parent d26f637 commit baedd2c

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CLAUDE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,43 @@ encountering broken installation instructions.
267267
The tests are designed to run on-demand via labels to avoid slowing down regular
268268
development workflow, as they can take significant time to complete.
269269

270+
### CHANGELOG Guidelines
271+
272+
When making significant changes that affect users or developers, update the
273+
CHANGELOG.md file:
274+
275+
#### CHANGELOG Structure
276+
277+
The CHANGELOG follows [Keep a Changelog](https://keepachangelog.com/) format
278+
with these sections under `## [Unreleased]`:
279+
280+
- **OCaml node** - Changes related to OCaml node compatibility
281+
- **Added** - New features and functionality
282+
- **Changed** - Changes to existing functionality
283+
- **Fixed** - Bug fixes
284+
- **Dependencies** - Dependency updates
285+
286+
#### Entry Format
287+
288+
- Use this format: `- **Category**: Description ([#PR](github-link))`
289+
- Wrap entries at 80 characters with proper indentation
290+
- Categories include: CI, Build System, Documentation, Development Tools, etc.
291+
- Always reference the PR number
292+
293+
#### CHANGELOG Commit Pattern
294+
295+
- Commit message: `CHANGELOG: add entry for patch XXXX`
296+
- Where XXXX is the PR number
297+
- Keep the commit message simple and consistent with existing pattern
298+
299+
Example entry:
300+
301+
```markdown
302+
- **CI**: Generalized build jobs to support multiple platforms (Ubuntu 22.04,
303+
Ubuntu 24.04, Ubuntu 24.04 ARM, macOS latest) and updated test execution to
304+
ubuntu-latest ([#1249](https://github.com/o1-labs/openmina/pull/1249))
305+
```
306+
270307
### Critical Pre-Commit Requirements
271308

272309
- **MANDATORY**: Run `make fix-trailing-whitespace` before every commit

0 commit comments

Comments
 (0)