kworkflow / kworkflow/patch-hub
Add small excerpt about scope and breaking changes of Conventional Commits to `CONTRIBUTING.md`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 36
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
In the Use Conventional Commits sections, there is no mention of the use of the scope and breaking changes syntax. For example, for a breaking feature that is specific to the foo module, the commit message should have a format like
feat(foo)!: introduce breaking change bar
I think this notion should be introduced really briefly with maybe one line of description and one line of example. I think a good reference is this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open CONTRIBUTING.md and start at the Use Conventional Commits section. Read the linked Conventional Commits specification for scope and breaking-change syntax, then add the brief explanation and foo example requested. Done means the section mentions both forms clearly and the example is formatted consistently with the surrounding guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100