Skip to content

docs: Start review guidelines#971

Merged
jstoobysmith merged 7 commits intomasterfrom
SpaceEdits
Mar 9, 2026
Merged

docs: Start review guidelines#971
jstoobysmith merged 7 commits intomasterfrom
SpaceEdits

Conversation

@jstoobysmith
Copy link
Member

Added review guidelines, very early draft that needs additions, but hopefully something which can be added to.

@jstoobysmith jstoobysmith added the documentation Improvements or additions to documentation label Mar 5, 2026
@morrison-daniel
Copy link
Collaborator

I would suggest adding What to consider when reviewing as well. It's technically written for a reviewer and not an author but I found it useful (especially the examples) when I first got started.

At the end I think it's worth adding something to the end explaining that much of the work on a PR happens during review so it doesn't need to be perfect to start a request, though they obviously should have made effort on their own to stick to these guidelines. I think it's good to be encouraging to new contributors, the review process can be intimidating.

As for length considerations, I have been using the rule of thumb that

  • < 50 lines = easy to check PR
  • < 100 lines = average sized PR
  • 100-200 lines = large PR, okay but try to break up if possible
  • 200+ lines = very large PR, should be broken up into smaller pieces
    Obviously these are not strict cutoffs but I've found it personally useful to judge where I'm at. Stuff like documentation and file organization can add lines without adding much complexity to review while definitions can be a few lines but usually require more effort than other additions of the same size. Often I will try to split changes in different files into different PRs.

To convince authors to follow length guidelines, it may be worth mentioning that limiting the length of a PR is good because

  • Small changes can be merged faster and not get blocked by unrelated work
  • Reduces the chance and impact of merge conflicts
  • Easier for reviewers to understand

Final suggestion, perhaps it would be worth explaining the basics of the tag system since we don't have automated tools for it at the moment.

jstoobysmith and others added 2 commits March 6, 2026 11:53
Co-Authored-By: Daniel Morrison <39346894+morrison-daniel@users.noreply.github.com>
Copy link
Collaborator

@morrison-daniel morrison-daniel left a comment

Choose a reason for hiding this comment

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

I fixed a couple spelling errors and am approving since it looks like no more changes are coming. Of course, feel free to keep editing if you like.

@jstoobysmith
Copy link
Member Author

Many thanks, will merge now. We can always add more things later.

@jstoobysmith jstoobysmith merged commit 5fd9a47 into master Mar 9, 2026
3 checks passed
@jstoobysmith jstoobysmith deleted the SpaceEdits branch March 9, 2026 05:40
@jstoobysmith jstoobysmith added the ready-to-merge This PR is approved and will be merged shortly label Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-to-merge This PR is approved and will be merged shortly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants