Skip to content

Add standardized PR template for docs repo#536

Open
rohanmalhotracodes wants to merge 1 commit into
oppia:developfrom
rohanmalhotracodes:pr-template-docs-only
Open

Add standardized PR template for docs repo#536
rohanmalhotracodes wants to merge 1 commit into
oppia:developfrom
rohanmalhotracodes:pr-template-docs-only

Conversation

@rohanmalhotracodes

Copy link
Copy Markdown
Contributor

Overview
This PR adds a pull request template to the web developer docs as it did not have one.

Linked Issue

This PR fixes #N/A, it was discussed with @HardikGoyal2003 oppia/oppia#25965 (comment)

Changes Made

  • Added a new default GitHub PR template file: .github/pull_request_template.md
  • Standardized required sections in the template such as overview, linked issue, changes made, testing and notes for reviewers

Testing

  • Verified hyperlinks work as expected
  • Checked linters pass locally
  • Confirmed instructions/steps added are accurate and work as expected

Notes for Reviewers

Note that it is slightly different from the proposed template as originally I had proposed Fixes# but it did not take into account Fixes part of # so the latter has been added to address the same.

@rohanmalhotracodes

Copy link
Copy Markdown
Contributor Author

PTAL @HardikGoyal2003

@rohanmalhotracodes

Copy link
Copy Markdown
Contributor Author

Ping @HardikGoyal2003 @U8NWXD

@@ -0,0 +1,18 @@
## Overview
Briefly describe what this PR does.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put these instructions in as comments? Otherwise I suspect many people will forget to remove them

Comment on lines +8 to +10
-
-
-

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's explicitly ask contributors to give a brief, high-level description of their changes

@U8NWXD U8NWXD assigned rohanmalhotracodes and unassigned U8NWXD May 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants