docs: Update "Let's Get Practical" and "Merge Conflicts" sections #100
Conversation
… to Date section and update Merge Conflicts section
…er Conflicts subsection
… Merge Conflicts subsection and minor wordings fix
… Started to How to Submit a Contribution section and update the wordings
…ving Merge Conflicts Immediately
…ng Merge Conflicts
✅ Deploy Preview for sauced-intro ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
|
I'd like to make sure I take a look at this in its entirety before it's merged in. I've done a quick glance but I'll get to the rest tomorrow morning. |
| - Using the CLI tool. | ||
| - Manually editing the `.all-contributorsrc` file. | ||
|
|
||
| Although adding yourself to the guest book with the CLI tool is simpler, we recommend manually editing the file to get more experience adding and committing your changes, creating pull requests, and pull request reviews. Below, you'll find the directions for each method: |
There was a problem hiding this comment.
This is just a note to say that we should evaluate this part in the future. We may want to encourage the CLI tool and then say something like, Once you've contributed to the guestbook, you can get more practice with the Pizza-verse repo or something. I think it would reduce the number of incomplete PRs.
There was a problem hiding this comment.
We definitely can review it in the future. 😊
What I see often happen with incomplete PRs is that folks tend to miss the step to generate the README either they use CLI or add manually.
The concern with adding manually is that if they don't stick to the list of there's a typo, it will break the CLI.
Description
This PR mainly updates:
It also improves and reorganize some parts of the "How to Contribute to Open Source" chapter to adjust and clarify above sections, and for better flow.
What type of PR is this? (check all applicable)
Related Tickets & Documents
Closes #99
Mobile & Desktop Screenshots/Recordings
Steps to QA
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?