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

Add "How To Get Your Pull Request Reviewed?" to developer handbook #40589

Merged
merged 16 commits into from
May 5, 2022

Conversation

adamziel
Copy link
Contributor

@adamziel adamziel commented Apr 25, 2022

What problem is this PR solving?

I wrote a "tutorial" to solve a common struggle – attracting a code review.

How does your PR solve it?

By adding a new handbook page. It contains the same tips as my popular Twitter thread. @carolinan on .org slack suggested it might be a useful addition to the developer's handbook, so here it is.

What feedback do you need?

  • Is this a good addition?
  • Would you phrase anything differently? I literally reused the same writing.

How to test?

  • Confirm the tests work.
  • Confirm the URLs are in the handbook format (to work both on wordpress.org and GitHub
  • Confirm the manifest.json change is sound

cc @atachibana @carolinan @t-hamano @talldan @gziolo @getdave @ryanwelcher @mkaz

@adamziel adamziel added [Type] Developer Documentation Documentation for developers Developer Experience Ideas about improving block and theme developer experience labels Apr 25, 2022
@adamziel adamziel force-pushed the docs/how-to-get-your-pull-request-reviewed branch from 33a710e to 0e2882d Compare April 25, 2022 12:27
Copy link
Contributor

@alexstine alexstine left a comment

Choose a reason for hiding this comment

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

This looks like a nice addition to me. I am not exactly sure of file structure so it would be best to have another review. 👍

I published a [Twitter thread](https://twitter.com/adamzielin/status/1515025299133583360) on this exact topic
and it received great feedback. @poena on .org slack suggested it might
be a useful addition to the developer's handbook, and so this PR
adds a new page explaining how to create effective PRs.
@adamziel adamziel force-pushed the docs/how-to-get-your-pull-request-reviewed branch from 0e2882d to 5ef05d6 Compare April 25, 2022 14:48
@gziolo gziolo requested a review from priethor April 25, 2022 14:55
@gziolo
Copy link
Member

gziolo commented Apr 25, 2022

There is a similar section in the Repository Management document:
https://github.com/WordPress/gutenberg/blob/trunk/docs/contributors/repository-management.md#code-review

It probably needs to be updated there or cross-linked between those two.

Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

Thanks @adamziel !

In general, I like the direct approach and tips of this update, although the Twitter-style approach sometimes doesn't translate too well in the handbook context (see inline discussions).


It’s the easiest way to get on others’ radar.

Look up the PRs of folks listed in the previous tweet and review them.
Copy link
Contributor

Choose a reason for hiding this comment

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

The tweet reference here is out of context.

docs/contributors/how-to-get-your-pull-request-reviewed.md Outdated Show resolved Hide resolved
docs/contributors/how-to-get-your-pull-request-reviewed.md Outdated Show resolved Hide resolved
docs/contributors/how-to-get-your-pull-request-reviewed.md Outdated Show resolved Hide resolved
docs/manifest.json Outdated Show resolved Hide resolved
@adamziel
Copy link
Contributor Author

Great feedback @priethor, thank you! I'll adjust the writing and ping you

Copy link
Contributor

@getdave getdave left a comment

Choose a reason for hiding this comment

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

This is good stuff. Just laying it out may help folks less experienced with working in the project (or in OS in general) to understand

  • how to get their PR reviewed
  • common pitfalls
  • why their currently PR isn't getting the attention they feel it deserves.

Left some comments.

@priethor
Copy link
Contributor

priethor commented Apr 26, 2022

Great review, @getdave ! These small changes convey a tone that better matches the Handbook 👌

@adamziel
Copy link
Contributor Author

adamziel commented May 4, 2022

@priethor @getdave I've addressed all the feedback – let me know what do you think now.

Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the feedback! 🚀

@adamziel adamziel force-pushed the docs/how-to-get-your-pull-request-reviewed branch from e2944e0 to 5d258da Compare May 5, 2022 11:47
@adamziel adamziel merged commit dd7aa57 into trunk May 5, 2022
@adamziel adamziel deleted the docs/how-to-get-your-pull-request-reviewed branch May 5, 2022 13:43
@github-actions github-actions bot added this to the Gutenberg 13.3 milestone May 5, 2022
@gziolo
Copy link
Member

gziolo commented May 5, 2022

Great work on this one 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer Experience Ideas about improving block and theme developer experience [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants