docs: update examples and tips on commit statistics #1162
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the example templates and adds a new tips & tricks section showcasing how to use
statistics
ingit-cliff
templates. It demonstrates how to include commit counts, durations, issue references, and other metrics in the generated changelog. Closes #1160Motivation and Context
The usage of the statistics object is currently under-documented, which may prevent users from utilizing it effectively in their templates. This PR addresses that gap by adding practical examples and tips to help users take advantage of the available data in a meaningful way.
How Has This Been Tested?
N/A
Types of Changes
Checklist: