Skip to content

docs: add commit and pr strategy section in tips and tricks #1218

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 10 commits into
base: main
Choose a base branch
from

Conversation

ognis1205
Copy link
Contributor

Description

Adds documentation describing the project's commit message and pull request strategy.

Motivation and Context

This change documents the limitations of using the rebase strategy when generating changelogs. In particular, it clarifies that:

  • With rebase or merge commit strategies, it is not possible to reliably trace a commit on the main branch back to its associated PR.

To address this, we recommend a consistent commit/PR strategy based on squash merging and Conventional Commits, which enables git-cliff to generate clear, contextual release notes. This documentation aims to guide contributors and maintainers toward that goal and provide a practical, opinionated baseline.

Relates to #1177 (does not close)

How Has This Been Tested?

N/A

Screenshots / Logs (if applicable)

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 July 17, 2025 00:40
@codecov-commenter
Copy link

codecov-commenter commented Jul 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 41.54%. Comparing base (9857d86) to head (24bf523).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1218      +/-   ##
==========================================
- Coverage   41.59%   41.54%   -0.05%     
==========================================
  Files          22       22              
  Lines        1919     1919              
==========================================
- Hits          798      797       -1     
- Misses       1121     1122       +1     
Flag Coverage Δ
unit-tests 41.54% <ø> (-0.05%) ⬇️

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 ognis1205 changed the title docs: add commit and pr strategy section in usage docs: add commit and pr strategy section in tips and tricks Jul 18, 2025
@ognis1205 ognis1205 requested a review from orhun July 18, 2025 21:08
@ognis1205
Copy link
Contributor Author

I’ve updated the documentation to reflect your feedback @orhun .
Let me know if anything else needs adjustment!

@orhun
Copy link
Owner

orhun commented Aug 2, 2025

This looks definitely better now!

However I'm not still sure if this document fits its place right now... but I don't know where else we can put this tbh...

Maybe separate FAQ section under quickstart?

@ognis1205
Copy link
Contributor Author

This looks definitely better now!

However I'm not still sure if this document fits its place right now... but I don't know where else we can put this tbh...

Maybe separate FAQ section under quickstart?

Got it, I’ll move it to a separate FAQ section under Quickstart.
If there are any other topics you think would be helpful to include there, I’m happy to add those as well!

@orhun
Copy link
Owner

orhun commented Aug 4, 2025

For now let's have these entries there first, then I'll think more about the other ones :)

@ognis1205
Copy link
Contributor Author

@orhun

Got it, thanks! I’ll leave those in for now.
Looking forward to your thoughts on the others later :)

@ognis1205
Copy link
Contributor Author

Hey @orhun ,

I’ve moved the content into the FAQ section under Quickstart as suggested. Let me know what you think, thanks!

Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
This reverts commit 5343297.

Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
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.

3 participants