ruanwenjun opened a new pull request, #18242:
URL: https://github.com/apache/dolphinscheduler/pull/18242
## Was this PR generated or assisted by AI?
YES — drafted with Claude Code assistance; reviewed and verified by the
author.
## Purpose of the pull request
The current `docs/docs/{en,zh}/contribute/join/commit-message.md` is out of
sync with how commits are actually written on `dev`. The documented format is
`[DS-ISSUE number][type] subject` with lowercase types
(`feat/fix/docs/style/refactor/test/chore`), but recent history uses
`[Type-ISSUE_ID][Scope] Subject` with capitalized types
(`Improvement/Fix/Chore/Doc/DSIP/Feature`). This PR refreshes the doc to match
practice and tightens the rules so contributors can produce consistent, concise
messages.
## Brief change log
- Rewrite `docs/docs/en/contribute/join/commit-message.md` and the matching
`zh` version:
- Format: `[Type-ISSUE_ID][Scope] Subject` (header) + optional body
(bulleted change list) + optional footer.
- Type list aligned with last 6 months of `dev` history: `Feature` /
`Improvement` / `Fix` / `Doc` / `DSIP` / `Chore`.
- Issue ID is required for every type **except** `Chore`. Subject targets
≤72 chars (soft).
- Detailed rationale / design / test plan should live in the PR
description (`PULL_REQUEST_TEMPLATE.md`), not the commit body.
- Added good/bad examples drawn from real `dev` commits.
- Update root `CLAUDE.md` commit-style line: fix the example format (no
space between `]` and `[`) and link to the full doc.
- Add `CLAUDE.local.md` to `.gitignore` so contributors using Claude Code
can keep personal overrides without polluting `git status`.
## Verify this pull request
This pull request is documentation only — no test coverage required.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
