Skip to content

Conversation

@gangulysiddhartha22-cmyk
Copy link
Contributor

Description:
Adds a new section to the merge conflicts guide explaining how to resolve common CHANGELOG.md conflicts directly in GitHub's web editor.

Related issue(s):

Fixes #1591

Notes for reviewer:
This is a documentation improvement with no code changes.

Checklist

  • Documented (Code comments, README, etc.)

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 26, 2026

Walkthrough

Adds an Unreleased CHANGELOG.md entry and expands docs/sdk_developers/merge_conflicts.md by adding a subsection on resolving CHANGELOG.md conflicts via GitHub's web editor and a reorganized, expanded local (VS Code) conflict-resolution guide; the web-editor guidance is duplicated.

Changes

Cohort / File(s) Summary
Changelog Entry
CHANGELOG.md
Added an "Unreleased → Added" entry: "Added guide for resolving CHANGELOG.md conflicts using GitHub's web editor (#1591)." (+1/-0)
Merge Conflicts Documentation
docs/sdk_developers/merge_conflicts.md
Replaced single ToC entry with two entries; added "Resolving CHANGELOG.md Conflicts Using GitHub's Web Editor" subsection with step-by-step web-editor instructions; added/expanded "Step-by-Step Guide to Resolve Merge Conflicts Locally" with VS Code–focused workflow, signing and force-push notes. Note: web-editor guidance appears twice. (+45/-2)

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly and concisely describes the main change: adding a guide for resolving CHANGELOG.md conflicts using GitHub's web editor, which is the primary objective of this documentation PR.
Description check ✅ Passed The PR description accurately relates to the changeset, explaining that it adds a new section to the merge conflicts guide for resolving CHANGELOG.md conflicts in GitHub's web editor, and references the related issue #1591.
Linked Issues check ✅ Passed The PR fulfills the core objectives from issue #1591: adding a new section to merge_conflicts.md explaining how to resolve CHANGELOG.md conflicts using GitHub's web editor, with steps and guidance. A CHANGELOG.md entry was also added as required.
Out of Scope Changes check ✅ Passed The changes are limited to the requested scope: adding a new section on web-editor-based CHANGELOG.md conflict resolution and expanding local resolution guidance in merge_conflicts.md, plus a single CHANGELOG.md entry. No unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch from 628b348 to f0a77eb Compare January 26, 2026 14:38
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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).

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch from f0a77eb to dfd664e Compare January 26, 2026 14:56
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch 2 times, most recently from 83ac444 to 8755e2e Compare January 26, 2026 15:07
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.dev rather than github.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.

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch from 8755e2e to aa0deaf Compare January 26, 2026 15:13
@gangulysiddhartha22-cmyk
Copy link
Contributor Author

@exploreriii just one new section added to merge_conflicts.md. git diff confirms.
ready for review. Thanks!

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch from aa0deaf to c07a684 Compare January 26, 2026 16:01
Copy link
Contributor

@aceppaluni aceppaluni left a 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

Copy link
Contributor

@exploreriii exploreriii left a 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!

@exploreriii exploreriii marked this pull request as draft January 27, 2026 02:21
@github-actions
Copy link

Hi, this is MergeConflictBot.
Your pull request cannot be merged because it contains merge conflicts.

Please resolve these conflicts locally and push the changes.

To assist you, please read:

Thank you for contributing!

@prajeeta15
Copy link
Contributor

@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]>
@gangulysiddhartha22-cmyk
Copy link
Contributor Author

@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!

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk marked this pull request as ready for review January 27, 2026 08:11
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch from c063554 to eeabc51 Compare January 27, 2026 09:47
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch from e80899d to f9bced9 Compare January 27, 2026 10:01
exploreriii
exploreriii previously approved these changes Jan 27, 2026
@codecov
Copy link

codecov bot commented Jan 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

@gangulysiddhartha22-cmyk gangulysiddhartha22-cmyk force-pushed the fix/1591-changelog-conflict-web-editor branch from 8dd4571 to 508355d Compare January 27, 2026 14:00
@prajeeta15
Copy link
Contributor

LGTM! great work! thank you :)

Copy link
Contributor

@prajeeta15 prajeeta15 left a 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.

exploreriii
exploreriii previously approved these changes Jan 28, 2026
@exploreriii exploreriii merged commit 5841133 into hiero-ledger:main Jan 29, 2026
18 checks passed
@exploreriii
Copy link
Contributor

Thank you very much @gangulysiddhartha22-cmyk !

@github-actions
Copy link

🎉 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:

  1. [Beginner]: Add Missing Type Hint to to_bytes Method in Transaction Class

    🐥 Beginner Friendly This issue is intended for contributors who have previously completed a Good First Issue in Hiero and are at a beginner level....

  2. [Beginner]: Add Missing Type Hints to sign Method in Transaction Class

    🐥 Beginner Friendly This issue is intended for contributors who have previously completed a Good First Issue in Hiero and are at a beginner level....

  3. [Beginner]: Implement __repr__ Method for TopicId Class

    🐥 Beginner Friendly This issue is intended for contributors who have previously completed a Good First Issue in Hiero and are at a beginner level....

  4. [Beginner]: Implement __repr__ Method for FileId Class

    🐥 Beginner Friendly This issue is intended for contributors who have previously completed a Good First Issue in Hiero and are at a beginner level....

  5. [Beginner]: Implement __repr__ Method for NftId Class

    🐥 Beginner Friendly This issue is intended for contributors who have previously completed a Good First Issue in Hiero and are at a beginner level....

🌟 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 🚀

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.

[Beginner]: Expand merge_conflicts.md to add a section on resolving changelog conflicts

5 participants