docs: Add a REVIEWING guide #1169
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Play this branch at https://endlessm.github.io/threadbare/branches/endlessm/docs-reviewing. (This launches the game from the start, not directly at the change(s) in this pull request.) |
wjt
commented
Sep 10, 2025
Comment on lines
+76
to
+80
| Unlike in some open-source projects, where the submitter is expected to make all | ||
| requested changes themself, the Threadbare maintainers may choose to fix issues | ||
| directly, on behalf of the submitter. We do this to reduce the number of times | ||
| that a pull request must be bounced between submitter and reviewer; and because | ||
| it is sometimes more efficient to make a change than to describe it. |
Member
Author
There was a problem hiding this comment.
@dsd you suggested documenting this particular point.
dsd
reviewed
Sep 10, 2025
docs/REVIEWING.md
Outdated
| description not matching our style, the maintainer may rewrite the title and | ||
| description, then merge the pull request; if we notice a typo, the maintainer | ||
| may fix it themself, then merge the pull request. We will always explain in | ||
| the pull request why we have made such changes. |
Member
There was a problem hiding this comment.
...with the aim of aiding the contributor in providing an even higher quality contribution next time.
(or something like that)
This serves the dual purpose of documenting the criteria by which we review a contribution, and encouraging community members to review others' contributions.
manuq
approved these changes
Sep 11, 2025
Contributor
|
Apologies for not seeing this sooner. I think the added language is great.
Do we have any details on content review as well? Not just technical?
(Guns, for example).
…On Thu, Sep 11, 2025, 5:19 AM Manuel Quiñones ***@***.***> wrote:
Merged #1169 <#1169> into main.
—
Reply to this email directly, view it on GitHub
<#1169 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AZ5WJ2H4EJFP6ZFX5SSUVV33SDE3ZAVCNFSM6AAAAACGE7CVIWVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJZGYZDINBZHA3TINA>
.
You are receiving this because your review was requested.Message ID:
***@***.***>
|
Member
Author
|
I'm working on that next! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This serves the dual purpose of documenting the criteria by which we
review a contribution, and encouraging community members to review
others' contributions.