Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creating a new Reviewing PRs wiki page #95

Merged
merged 11 commits into from
Feb 24, 2025

Conversation

reticent-rem
Copy link
Contributor

Correction/Clarification?

Summary

Saugia & roadrunner56 suggested in another PR comment thread that it could be valuable to add a wiki page around PR reviewing, so here it is!

mOctave wrote a superb set of tips for reviewers last year, so I've shamelessly linked it here and added a slightly condensed version to this doc. Definitely want any thoughts or tweaks since this is essentially those same tips.

@roadrunner56
Copy link
Member

Thanks for doing this!
Perhaps you could link the StyleGoals page for when someone is reviewing a writing PR? Makes sense for a reviewer to know what the game's writing and grammar guidelines are.
Also, perhaps we should add something about how to review PRs on a basic, literal level - like 'go to the PR on GitHub, select "files changed", click on a line you want to make a suggestion for', etc. etc. because I know when I was starting out I didn't know any of that stuff. I think it would be helpful to people who aren't familiar with Github's UI.

Thanks TheGiraffe3 & roadrunner56!

Co-authored-by: Loymdayddaud <[email protected]>
Co-authored-by: roadrunner56 <[email protected]>
Copy link
Contributor Author

@reticent-rem reticent-rem left a comment

Choose a reason for hiding this comment

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

Great ideas, thanks! I added a tip bullet pointing to the style guide & wiki more generally, and linked resources for creating a Github account/reviewing your first PR. I think those suggestions will help first time contributors a lot with getting started!

Co-authored-by: Loymdayddaud <[email protected]>
@warp-core warp-core added the standalone A PR that doesn't require an endless-sky PR to be merged. label Feb 23, 2025
Co-authored-by: roadrunner56 <[email protected]>
Copy link
Contributor

@mOctave mOctave left a comment

Choose a reason for hiding this comment

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

I haven't actually done any spelling or grammar checking on this (at least not yet), but I approve of my writing being used in this context.

@roadrunner56 roadrunner56 merged commit d32c833 into endless-sky:master Feb 24, 2025
1 check passed
warp-core added a commit that referenced this pull request Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
standalone A PR that doesn't require an endless-sky PR to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants