Repository navigation
Add guide: Updating Fork Repository Branches #50
Description
Description
Hello, we need a guide document at Guides/Conflicts_Guide that explains how contributors can update their fork's branches with the latest branches from the base repository.
The guide should provide clear, step-by-step instructions for keeping fork branches in sync with the upstream repository, especially when contributors need to complete multiple merge-conflict tasks, which would require them to access their newly created branch.
Issue Context
During the merge-conflict contribution tasks, contributors can choose between the text and code versions.
However, a problem occurs when a contributor wants to complete both tasks. Since GitHub does not allow a user to fork the same repository twice, the contributor needs to update their existing fork and create or update the required branches within it.
Currently, we don't have a guide explaining how to do this. This can make it difficult for contributors who want to participate in the tasks more than once, especially when they need to work with branches that have been added or updated in the base repository.
Expected Outcome
Create Guides/Conflicts_Guide containing a clear guide that explains:
- How to fetch the new branch created for them in the base/upstream repository.
- How to update an existing fork with branches from the base repository.
- Any relevant GitHub/Git commands contributors need to run.
- How to verify that their fork is up to date and ready for the next contribution.
The document can be generalised so that users can reference it while building on other projects too
while using the current project as the primary context.
Once the guide is complete, reference it from:
README.mdcli_guide.md
This will ensure that contributors returning to the tasks for a second time can easily find the instructions and avoid running into branch synchronization issues.
The goal is to make it possible for contributors to complete both the text and code merge-conflict tasks using a single fork, without needing to create another fork or manually figure out how to synchronize their branches.
Note
Note on AI Usage
You can use AI while working on this task, but it should not be given the issue and asked to complete the document for you. Instead, use AI as a writing assistant while you, as the author working on the core document yourself.
For example, you can use it to:
- Enhance or refine your existing text
- Fix spelling and grammar errors
- Make unclear sections easier to understand
- Help improve the structure and flow of your writing
I believe everyone has their own unique way of writing and expressing their ideas, and that's what we need. AI should only help bring your thoughts into a clearer form, not replace them.
Otherwise, we could have just handed the whole thing to AI and called it a day. :P
Activity