Skip to content

docs: update examples and tips on commit statistics #1162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ognis1205
Copy link
Contributor

Description

This PR updates the example templates and adds a new tips & tricks section showcasing how to use statistics in git-cliff templates. It demonstrates how to include commit counts, durations, issue references, and other metrics in the generated changelog. Closes #1160

Motivation 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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@ognis1205 ognis1205 requested a review from orhun as a code owner June 4, 2025 00:06
@codecov-commenter
Copy link

codecov-commenter commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.92%. Comparing base (6db7d49) to head (719c8be).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1162   +/-   ##
=======================================
  Coverage   41.92%   41.92%           
=======================================
  Files          21       21           
  Lines        2009     2009           
=======================================
  Hits          842      842           
  Misses       1167     1167           
Flag Coverage Δ
unit-tests 41.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ognis1205
Copy link
Contributor Author

@orhun

Thanks for the review! I’ll make the changes as per your suggestions and ping you again once they’re ready.

@ognis1205 ognis1205 requested a review from orhun June 13, 2025 07:45
@ognis1205
Copy link
Contributor Author

Hey @orhun,

I’ve addressed all the points that were raised in the review.
Let me know if there’s anything else you’d like me to revise or clarify.
Also, please review #1151 together with this one when you have a chance.

Thanks!

@ognis1205 ognis1205 force-pushed the docs/commit-statistics branch from d8f06aa to 2ce30fb Compare June 14, 2025 17:14
@orhun
Copy link
Owner

orhun commented Jun 16, 2025

This is blocked by #1151

@ognis1205 ognis1205 force-pushed the docs/commit-statistics branch from 6ba3d79 to 719c8be Compare June 22, 2025 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add example and tips & tricks regarding PR #1151
3 participants