di-sukharev / di-sukharev/opencommit
[Feature]: Branch Naming Integration for Enhanced Commit Messages in OpenCommit
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 7.5k
- Forks
- 445
- Avg merge
- 18m
- Merged PRs (30d)
- 2
Description
Description
integrate branch naming conventions into the commit message generation process. Users frequently use branch names like feature/{ticketnumber}-normal-branch-name in their version control workflows. However, they have to manually include the ticket number in their commit messages, which can be tedious and error-prone.
Suggested Solution
Implement a new feature that allows for automatic extraction of ticket numbers from branch names. When a branch is named in a specific format (e.g., feature/{ticketnumber}-normal-branch-name), OpenCommit should detect the ticket number and prepend or append it to the commit message, formatted as ticket: {ticketnumber}. This functionality would significantly streamline the commit process, reduce manual errors, and improve efficiency. The implementation should be flexible to accommodate different branch naming conventions and should be easily configurable through the existing settings. Additionally, offering an option to toggle this feature on or off per repository basis would provide users with greater control and customization.
Alternatives
No response
Additional Context
No response
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
Start by tracing the branch-name and commit-message generation entry points, then inspect the existing settings flow for repository-level options. Define the supported branch patterns, ticket extraction behavior, message placement, and enable/disable configuration before implementing. Done means matching ticket numbers are added consistently, unsupported names remain safe, and the feature can be toggled per repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, javascript
- Domain
- cli, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100