Fix #356: Make "Create a Good PR" tutorial #457

LittleRainC · 2025-04-28T13:21:45Z

Fix #356: Make "Create a Good PR" tutorial -> Make "Create a Good PR" tutorial.

Changed files:

Add a "Create a Good PR" file - add the page of it
Siderbar.md - add a link for "Create a Good PR" under "Making your first PR" - "Rules for making PRs"

add "Create a Good PR" under "Making your first PR"

Add table of content part

seanlip

Thanks @LittleRainC! Left some notes, PTAL.

seanlip · 2025-05-01T03:41:05Z

_Sidebar.md

@@ -32,6 +32,7 @@
      * [[Tips for analyzing the codebase|Analyzing-the-codebase]]
    * [[Learning resources for developers|Learning-Resources]]
    * [[Rules for making PRs|Rules-for-making-PRs]]
+      * [[Create a Good PR|Create a Good PR]]


Maybe we should reorganize this section...

Good first issues (bolded)

Tips for finding the right code to change

Finding the commit that introduced a bug

Tips for analyzing the codebase

How to create a good PR (your new page, bolded)

Rules for making PRs

Coding style guide

and we move the learning resources for developers to the "getting started" section above? Just some thoughts, feel free to suggest a better ordering -- we want devs to discover this page. :)

adjusted as pointed above

adjusted as pointed

seanlip · 2025-05-01T03:41:28Z

Create a Good PR.md

+- [Reviewers Appreciate...](#reviewers-appreciate)
+- [Need Help?](#need-help)
+
+This page is an introduction to creating a great Pull Request(PR). A great Pull Request (PR) is more than just code—it’s clean, clear, and easy for reviewers to understand. This guide shares best practices for writing high-quality PRs that are easy to review and quick to merge.


add space between "Pull Request" and "(PR)" in first sentence

adjusted as pointed above

adjusted -> Create a Good PR

seanlip · 2025-05-01T03:41:52Z

Create a Good PR.md

+
+Contributing code is awesome—but making it **easy to review** is just as important. A thoughtful PR saves time for reviewers, avoids misunderstandings, and helps Oppia maintain a high standard of quality.
+
+## Before You Open Your PR


In this doc, do you need to refer to the more detailed "PR guide" at some point?

I added a link for the detailed PR guide as a essential checklist, and I think it might be okey?

I added a link for the detailed PR guide.

seanlip · 2025-05-01T03:42:50Z

Create a Good PR.md

+
+## Final Checklist Before You Request Review
+
+- My PR addresses **one issue only**


Format as a checklist using - [ ] ...? (Not sure)

adjusted as pointed above

Replaced all the "-" with "- [ ]"

seanlip · 2025-05-01T03:43:07Z

Create a Good PR.md

+Don’t be afraid to ask! You can:
+
+- Tag reviewers in comments
+- Use GitHub Discussions


Link to the relevant github discussions category

added that link

seanlip · 2025-05-01T03:43:16Z

Create a Good PR.md

+
+- Tag reviewers in comments
+- Use GitHub Discussions
+- Ask in Oppia’s chat or community channels


How does this differ from the previous bullet point?

Removed "Ask in Oppia's chat or community channels"

This is really a good point. I removed "Ask in Oppia's chat or community channels"

Moved the learning resources for developers to the "getting started" section above. Adjusted the structure of makings PRs.

1. Added space between "Pull Request" and "(PR)" in first sentence 2. Added a refer to the more detailed "PR guide" at some point 3. Used a checklist format - [ ] 4. Linked the relevant github discussions category 5. Removed the "Ask in Oppia’s chat or community channels".

seanlip · 2025-05-05T16:21:04Z

@LittleRainC Please don't resolve review comments, it makes it hard for reviewers to tell what has and hasn't been addressed. Follow the instructions in step 5 here and make sure that the assignee is correct as well.

Please fix the above and ensure you are following the correct PR review process -- thanks.

seanlip

Thanks, looks good! Just one small note.

seanlip · 2025-05-07T19:10:29Z

Create a Good PR.md

+
+A good pull request isn’t just about working code—it’s about making collaboration easier. Clear, well-structured PRs save reviewers time, reduce confusion, and help maintain high code quality. In open source, thoughtful PRs build trust and keep the project maintainable for everyone.
+
+For the essential checklist and best practices, be sure to follow [Rules for making PRs](./rules-for-making-prs.md)—every good PR starts there. 


There's a syntax you can use for links to other pages in the same wiki -- please look at the other wiki pages for how to do this, so that the md files follow a consistent style.

@LittleRainC The syntax is [Rules for making PRs|Rules-for-making-PRs], right? Please check other wiki pages to make sure I got this correct.

I think it should be [Rules for making PRs](https://github.com/oppia/oppia/wiki/Rules-for-making-PRs)". Because in Tutorial-Learn-How-to-Fix-a-CI-Flake-waitFor-Statements.md, you can notice that they used the same syntax.

seanlip · 2025-05-12T17:44:45Z

@LittleRainC Are you still working on this PR?

Updated the link for "Rule for making PRs"

LittleRainC · 2025-05-12T19:49:23Z

@seanlip Yeah, I'm just a bit busy last week. Sorry!

seanlip · 2025-05-17T19:52:14Z

Thanks @LittleRainC! Please resolve the merge conflicts, and then I think we can merge this.

seanlip · 2025-06-02T13:11:00Z

@LittleRainC Sorry, one more comment -- #457 (comment)

LittleRainC added 3 commits April 28, 2025 08:36

Add "Create a Good PR" file

3df411b

Update _Sidebar.md

8eeaa12

add "Create a Good PR" under "Making your first PR"

Update Create a Good PR.md

48f6f19

Add table of content part

LittleRainC mentioned this pull request Apr 28, 2025

Make "Create a Good PR" tutorial #356

Open

seanlip requested changes May 1, 2025

View reviewed changes

seanlip assigned LittleRainC May 1, 2025

LittleRainC added 2 commits May 1, 2025 00:28

Update _Sidebar.md

1b77d8f

Moved the learning resources for developers to the "getting started" section above. Adjusted the structure of makings PRs.

LittleRainC requested a review from seanlip May 1, 2025 05:51

seanlip requested changes May 7, 2025

View reviewed changes

LittleRainC added 2 commits May 12, 2025 15:27

Merge branch 'oppia:develop' into dev_branch2

88b8030

Update Create a Good PR.md

a415e0f

Updated the link for "Rule for making PRs"

Merge branch 'develop' into dev_branch2

5355fd9

Merge branch 'oppia:develop' into dev_branch2

8d3356a


		Contributing code is awesome—but making it easy to review is just as important. A thoughtful PR saves time for reviewers, avoids misunderstandings, and helps Oppia maintain a high standard of quality.

		## Before You Open Your PR


		## Final Checklist Before You Request Review

		- My PR addresses one issue only


		A good pull request isn’t just about working code—it’s about making collaboration easier. Clear, well-structured PRs save reviewers time, reduce confusion, and help maintain high code quality. In open source, thoughtful PRs build trust and keep the project maintainable for everyone.

		For the essential checklist and best practices, be sure to follow [Rules for making PRs](./rules-for-making-prs.md)—every good PR starts there.

Fix #356: Make "Create a Good PR" tutorial #457

Are you sure you want to change the base?

Fix #356: Make "Create a Good PR" tutorial #457

Uh oh!

Conversation

LittleRainC commented Apr 28, 2025

Uh oh!

seanlip left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seanlip commented May 5, 2025

Uh oh!

seanlip left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seanlip commented May 12, 2025

Uh oh!

LittleRainC commented May 12, 2025

Uh oh!

seanlip commented May 17, 2025

Uh oh!

seanlip commented Jun 2, 2025

Uh oh!

Uh oh!