docs: Add "Keeping Branch Up to Date and Resolving Merge Conflicts" section #123
Conversation
…m/adiati98/guestbook into docs/add-resolve-conflict-section
…s/add-resolve-conflict-section
Thanks! Now just need to discuss about the screen recordings before I make this ready for review ;) |
There was a problem hiding this comment.
Although I think that adding screenshots are helpful, they aren't necessary especially if this remains in the readme. With the README, it's important that we don't overwhelm contributors with too much. I think that screenshots will start to make the README feel too long. I do have this blog post written about it that can be referenced here that has screenshots.
Depending on how things change here, we might want to add another folder in the repo for community-resources that includes translations and the info here, but I think for now, the repo is still manageable.
|
@BekahHW this PR can't be merged because there were unresolved reviews from @CBID2. Now I closed them as resolved. You can try again. If it doesn't work, you need to override @CBID2 review. I did this before in one PR, but forgot to take note.
Update: FYI @BekahHW @CBID2,
And don't forget to give brief description why you want to dismiss the review.
|
Description
This PR adds the Keeping Branch Up to Date and Resolving Merge Conflicts section to walk through the process for this project.
Note for Reviewers
Because there is CLI involved for this project, screen recordings (GIFs) will be more clear than screenshots. So there will be GIFs (or video walkthrough) provided, but how to add them here is to be advised.
One of the steps to resolve conflict is to move contributor's profile details to the last list in the contributors array. This step is necessary because without it, the PRs that are awaiting for review have to update their branch locally and run
npm run contributors:generateto regenerate the badge. It will be too complicated and discouraging for this simple project --> this is one of the reasons that the process won't be too clear with screenshots.Once this PR is merged, there will be another PR following to add GIFs.
Videos walkthrough are planned to replace GIFs in the future.
What type of PR is this? (check all applicable)
Related Tickets & Documents
Refers to #118
Mobile & Desktop Screenshots/Recordings
Added tests?
Added to documentation?
[optional] Are there any post-deployment tasks we need to perform?
[optional] What gif best describes this PR or how it makes you feel?