Skip to content

docs: add REVIEW_GUIDELINES.md#7506

Open
UtkarshAnandd wants to merge 1 commit into
sugarlabs:masterfrom
UtkarshAnandd:docs/review-guidelines
Open

docs: add REVIEW_GUIDELINES.md#7506
UtkarshAnandd wants to merge 1 commit into
sugarlabs:masterfrom
UtkarshAnandd:docs/review-guidelines

Conversation

@UtkarshAnandd

Copy link
Copy Markdown

Closes discussion #6925

Compiling the Review Guide discussed in the Ideas thread into a
REVIEW_GUIDELINES.md file, incorporating suggestions from:

The guide covers:

  • Pre-PR checklist for contributors
  • Best practices for reviewers
  • Contributor journey stages

Signed-off-by: ITACHI161105 <utkarsha137@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

🧪 Jest Test Results

✅ All Jest tests passed! This PR is ready to merge.

Coverage: Statements: 48.37% | Branches: 40.07% | Functions: 53.06% | Lines: 48.76%
Master Coverage: Statements: 48.37% | Branches: 40.07% | Functions: 53.06% | Lines: 48.76%

@Ashutoshx7

Copy link
Copy Markdown
Collaborator

@vyagh @zealot-zew guys your thoughts on this

Comment thread REVIEW_GUIDELINES.md
Comment on lines +20 to +24
## Contributor Journey
1. Start with small fixes and suggest changes
2. After 8-10 merged PRs, request approval rights
3. With experience, propose performance improvements
and new features — discuss with mentors first No newline at end of file

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Out of scope for review guidelines, right?

@vyagh

vyagh commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator
  1. browser smoke test (when applicable) is missing, that's a very important one.
  2. We should explicitly mention the problem where contributors open a single PR, which clearly should have been multiple PRs (this is quite common)
  3. would be nice to mention about "Thoroughly check the folder directory especially for tests" comment from the discussion, sometimes new test files are created when the tests could've been just added to existing test files.
  4. let's not close the discussion even after merging this PR, I believe the discussion can be used further to keep improving this guide?

@ssz2605 ssz2605 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Few more points that could be added under the contributor checklist:

  • For feature, UI/UX, or workflow changes, include before-and-after screenshots, GIFs, or a short video demonstrating the change.
  • For performance-related changes, provide before-and-after benchmark results, performance graphs, or screenshots of relevant metrics along with a brief explanation of the measurable impact created by the optimization.

This helps reviewers understand the change more quickly, validate the claimed improvements, and reduces the effort required to reproduce the results locally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

4 participants