Review a Pathway Guide

Help keep pathways accurate and newcomer-friendly by actually completing the contribution a guide describes. Follow every step as a first-timer would, note where you get stuck or confused, flag broken links, and file an issue with what you find.

  • Reference: About Pathways — purpose and principles of contribution pathways
  • Connect: Join #core-program and introduce yourself, saying you’ll be reviewing pathways

Steps

  1. Pick a pathway to review. Choose from Walkthrough Requests and add a comment to indicate you’re working on it. If you type /assign as your comment, our workflows will assign the issue to you.

  2. Complete its contribution as a newcomer. Follow every step from the top as if it’s your first contribution. Don’t skip anything: click the links, run the setup, and most importantly, try completing that contribution.

  3. Check all links. Verify that every link works and points to the right place.

  4. Note any unclear sections. If instructions are confusing, steps are missing, or the tone feels off, mark it. The goal is to spot what trips up a first-timer.

  5. File an issue with your findings. Report what worked and what didn’t. Be specific: “Step 3 assumes I already have X installed” or “The link in step 2 is broken.” If you discover a related bug, mention it and link to any context you’ve found. Include suggested rewording if you have it — paste the original text along with your version.

  6. Signal it’s done. Comment with your findings. If you’ve completed the contribution successfully, add another comment with just /done in it, and we’ll close the issue.

Contribution checklist

  • Completed the contribution, following every step of the guide
  • Verified all links work and point to the correct resources
  • Commented with your findings
  • Filed an issue with specific, actionable feedback if needed

What happens next

If you’ve shared feedback, the pathway author or a maintainer will review it. If there’s no response after a week, a polite pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” in the relevant team’s SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/ is fine.

When you’re ready, review another pathway or try creating one.

Help

Stuck? Check the getting help guide, then ask in the relevant team’s Slack channel (the pathway should list which team owns it).

Further reading:
TEMPLATE.md — pathway structure and guidelines

Test
Beginner-friendly project

New here? Get set up with accounts, community basics, and info on badges.