-
Notifications
You must be signed in to change notification settings - Fork 185
docs: add guide for resolving CHANGELOG.md conflicts using GitHub web editor #1601
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
docs: add guide for resolving CHANGELOG.md conflicts using GitHub web editor #1601
Conversation
WalkthroughAdds an Unreleased CHANGELOG.md entry and expands Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
628b348 to
f0a77eb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
♻️ Duplicate comments (1)
docs/sdk_developers/merge_conflicts.md (1)
231-231: Fix capitalization: "GitHub.dev" not "github.dev".The official name of the GitHub web-based editor is "GitHub.dev" with a capital "H".
✏️ Capitalization fix
-For more details on GitHub's web-based editor, see: [The github.dev web-based editor](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor). +For more details on GitHub's web-based editor, see: [The GitHub.dev web-based editor](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor).
f0a77eb to
dfd664e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/sdk_developers/merge_conflicts.md (1)
200-209: Fix markdown list numbering to maintain continuity.The code block at lines 203-207 breaks the numbered list sequence. Markdown requires code blocks within lists to be indented with 3 spaces (or use fenced code blocks with proper indentation) to maintain list continuity. Without this, steps 3-9 will render as a separate list starting from 1.
📝 Proposed fix to maintain list numbering
2. Find the conflicted CHANGELOG.md file. You'll see a preview of the conflict with markers, often looking like this: -<<<<<<< HEAD -[Content from current branch/HEAD] -======= -[Content from incoming branch] ->>>>>>> [commit-hash-or-branch-name] + + ``` + <<<<<<< HEAD + [Content from current branch/HEAD] + ======= + [Content from incoming branch] + >>>>>>> [commit-hash-or-branch-name] + ``` 3. Look for the online editor at the bottom of the PR file preview.The key is indenting the code block with 3 spaces and wrapping it in fenced code block markers.
83ac444 to
8755e2e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/sdk_developers/merge_conflicts.md (1)
231-231: Minor: Use official capitalization for GitHub.dev.The official branding uses a capital "H":
GitHub.devrather thangithub.dev.✏️ Proposed fix
-For more details on GitHub's web-based editor, see: [The github.dev web-based editor](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor). +For more details on GitHub's web-based editor, see: [The GitHub.dev web-based editor](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor).As per coding guidelines, keeping feedback focused on correctness.
8755e2e to
aa0deaf
Compare
|
@exploreriii just one new section added to |
Signed-off-by: Siddhartha Ganguly <[email protected]>
aa0deaf to
c07a684
Compare
aceppaluni
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gangulysiddhartha22-cmyk Thank you for your contribution!
LGTM!
Requesting further review from @hiero-ledger/hiero-sdk-python-triage
exploreriii
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great!
Can we make a couple of edits to make it even easier for new contributors?
Thank you!
|
Hi, this is MergeConflictBot. Please resolve these conflicts locally and push the changes. To assist you, please read: Thank you for contributing! |
|
@gangulysiddhartha22-cmyk can you please make the requested edits and resolve the merge conflicts. everything else looks good and ready to be merged :) |
Signed-off-by: Siddhartha Ganguly <[email protected]>
|
@exploreriii I made all the changes as you mentioned. Coincidentally, I got a merge conflict in the CHANGELOG.md file and solved it using the web editor. Please review. I'm always up for further modifications. Thank you very much! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
c063554 to
eeabc51
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Signed-off-by: Siddhartha Ganguly <[email protected]>
e80899d to
f9bced9
Compare
Signed-off-by: gangulysiddhartha22-cmyk <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #1601 +/- ##
=======================================
Coverage 92.89% 92.89%
=======================================
Files 140 140
Lines 8765 8765
=======================================
Hits 8142 8142
Misses 623 623 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
c061e68 to
9294074
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Signed-off-by: Siddhartha Ganguly <[email protected]>
8dd4571 to
508355d
Compare
|
LGTM! great work! thank you :) |
prajeeta15
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ready to merge. all issues resolved.
|
Thank you very much @gangulysiddhartha22-cmyk ! |
|
🎉 Congratulations on completing a beginner/Good First Issue! Thank you for your contribution to the Hiero Python SDK! We're excited to have you as part of our community. Here are some similar issues you might be interested in working on next:
🌟 Stay connected with the project:
We look forward to seeing more contributions from you! If you have any questions, feel free to ask in our Discord community. From the Hiero Python SDK Team 🚀 |
Description:
Adds a new section to the merge conflicts guide explaining how to resolve common
CHANGELOG.mdconflicts directly in GitHub's web editor.Related issue(s):
Fixes #1591
Notes for reviewer:
This is a documentation improvement with no code changes.
Checklist