-
-
Notifications
You must be signed in to change notification settings - Fork 238
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
base: main
Are you sure you want to change the base?
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
I’ve updated the documentation to reflect your feedback @orhun . |
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. |
For now let's have these entries there first, then I'll think more about the other ones :) |
Got it, thanks! I’ll leave those in for now. |
18a633d
to
7e8e820
Compare
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>
5e129d7
to
24bf523
Compare
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:
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
Checklist: