MaibornWolff / MaibornWolff/codecharta
SCMLogParser Handle Reverts
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 529
- Forks
- 56
- Avg merge
- 7h 17m
- Merged PRs (30d)
- 34
Description
# Feature request
Add an option to handle reverted commits.
## Description
As a user I want the option to controll if reverted commits should be included in the calculation or not.
If they are not included I expect the parser to correctly substract reverted metrics as well, removing the previosly calculated commit.
## Acceptance criteria
- the parser supports a new flag to toggle revert commit handling, which is false per default
- setting the flag to true will result in the parser watching for reverted commits and not including them in the final calculation
- in case of reverted commits the previously calculated metrics for the commit are also correctly substracted
- the parser needs to only recognize reverts by the 'Revert someHashVlaue' construct in commit title
## Assumptions & Exclusions
- exclusion: custom revert messages are not considered, maybe in a further PR
## Development notes (optional Task Breakdown)
- [ ] add flag for toggeling revert commit modemode
- [ ] 'Revert someHashVlaue' construct in commit title
- [ ] adjust reverted metrics accordingly
Contributor guide
No contributing guide indexed for this repository
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 locating SCMLogParser and its existing commit-metric calculation. Trace how commit titles are parsed, then use the acceptance criteria to verify the default-off flag, exact “Revert someHashVlaue” recognition, exclusion from the final calculation, and subtraction of the reverted commit’s metrics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100