Content operations
How to contribute
Anyone can improve this guide — fix a typo in your browser, or propose new guidance through a structured review.
Ways to contribute#
Quick fixes (minutes)#
Typos, broken links, unclear sentences. Use the "Suggest an edit on GitHub" link at the bottom of any page — it opens the page's MDX file in the GitHub editor. Submit the change as a pull request; no local setup needed.
New examples (an hour)#
Real Do/Don't examples are the guide's most valuable asset. Open a pull request adding examples to an existing page, anonymising any product-specific details. Say in the PR description where the example came from (research, support tickets, shipped copy).
New guidance (a proposal)#
New pages and changes to recommendations go through the proposal process, so the community can weigh evidence before the guide's position changes.
Discussion and review#
Join GitHub Discussions to answer questions, or review open pull requests — editorial review is a contribution too.
A typical workflow#
- Check existing issues and discussions for your topic.
- Open an issue describing the problem the guidance solves.
- Fork, branch, and write following the editorial standards.
- Open a pull request linking the issue.
- An editor reviews within two weeks; changes merge with credit in the changelog.
Note
First contribution to open source? Say so in your PR — a maintainer will guide you through. The guide exists to lower barriers, including this one.
Related guidance#
Spotted a problem with this page? Suggest an edit on GitHub.