Skip to content

Commit 35fc914

Browse files
committed
docs: update README.md with complete configuration options
Added documentation for all supported configuration options: - commit-msg.changeId as alternatives to gerrit.createChangeId - commit-msg.coDevelopedBy These new configuration options provide more consistent naming and better alignment with the tool name. Change-Id: I66ecccadcf5c78e002554b8060919c8413539a50 Co-developed-by: Claude <noreply@anthropic.com> Signed-off-by: Jiang Xin <zhiyou.jx@alibaba-inc.com>
1 parent 1df3876 commit 35fc914

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ npm run dev -- <command>
4040
```
4141

4242
This command now uses `commit-msg.dev.ts` for development mode with the following enhancements:
43+
4344
- Suppresses experimental warnings with `NODE_OPTIONS=--no-warnings`
4445
- Uses a separate development entry point for better TypeScript import handling
4546

@@ -87,7 +88,8 @@ When building the project, only the production files are compiled to the `dist`
8788
The tool follows these Git configuration options:
8889

8990
- `gerrit.createChangeId` - Boolean to control whether to generate Change-Id (default: true)
90-
- `commit-msg.coDevelopedBy` - Boolean to control whether to add Co-Developed-By (default: true)
91+
- `commit-msg.changeId` - Boolean to control whether to generate Change-Id (alternative to gerrit.createChangeId, default: true)
92+
- `commit-msg.coDevelopedBy` - Boolean to control whether to add Co-developed-by (default: true)
9193
- `core.commentChar` - Defines the comment character (defaults to #)
9294
- `core.hooksPath` - Defines alternative path for hooks
9395

0 commit comments

Comments
 (0)