conversadocs / conversadocs/code-scan-docs

[Task]: conventional commit formatting

Open
#31 0 comments 0 reactions 1 assignee Claimed by @tkrief1 View on GitHub
Dominant language
Rust
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Description

Format the generated messages into the conventional commits style, ensuring appropriate categorization and structure.

### Acceptance Criteria

- [x] Commit messages start with the correct type and optional scope (e.g., `feat(parser): ...`).
- [x] Imperative, present tense is used in the message summary.
- [x] Breaking changes are indicated with an exclamation mark and detailed in the message body.
- [x] A detailed body is included when necessary, providing additional context.
- [x] Footer sections are added for issues references or metadata.
- [x] The formatting adheres strictly to the [Conventional Commits specification](https://www.conventionalcommits.org/).
- [x] Automated checks validate the format of the generated commit messages.
- [x] Documentation provides examples of the formatted messages.

### Notes

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.