docs: add upstream sync steps to CONTRIBUTING.md #3477
+10
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes adenhq#2692 Added steps to configure the upstream remote and sync the main branch before creating a feature branch. This helps contributors avoid starting from stale code and reduces merge conflicts.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2692
Problem
The current "Getting Started" section in
CONTRIBUTING.mdlacks instructions on how to keep a local fork in sync with the upstream repository. This can lead to contributors basing their work on stale code, resulting intro merge conflicts or CI failures.Solution
Added explicit steps to:
upstreamremote.upstream/mainbefore creating a feature branch.This ensures a smoother contribution experience for newcomers.