Contribute
Help build FirstPass
The FirstPass code is public and open to contributions from anyone. Google’s rules change often, and many people notice what is wrong before we do. If you know something we don’t, you can help.
Ways to help
| You want to... | Do this |
|---|---|
| Report a rule that is wrong or out of date | Open an issue with the A rule is wrong or out of date template. Add Google’s page and the date you read it. |
| Report a bug | Open an issue with the Bug report template. |
| Suggest a check, a question or a feature | Open an issue with the Idea template. |
| Improve the wording | Send a pull request. Plain language is the whole point of the project. |
| Fix a bug or build something | Send a pull request. The steps are below. |
| Ask for iOS | Use the feedback form or open an idea. |
No code? Start here
You don’t need to be a developer. The most valuable contribution is often a sentence: “Google rejected my app for this, and FirstPass didn’t warn me.” Rejections you have really been through are exactly what the rules are built from.
- Not on GitHub? The feedback form goes straight to the team, and needs no account.
- On GitHub? Open an issue. It takes two minutes.
- Looking for something to work on? The roadmap lists what is planned and what is being explored.
- Spotted a typo or a confusing sentence? Every page can be fixed with a small pull request, and GitHub lets you edit a file right in the browser.
Send a change
- Fork the repository and clone your fork.
- Make a branch, then install and run it. Everything works with no settings.
npm install npm run dev
- Make one focused change.
- Run the checks. They must pass.
npx tsc --noEmit npx eslint app lib components npm run build
- Push your branch and open a pull request. Fill in the template. A maintainer will review it.
The developer guide shows where things live and how to add a rule (lib/rules.ts) or a question (lib/questions.ts).
Rules about rules
- Cite Google. A new or changed rule must link to Google’s own page and say when you read it. Policies change, and a number without a source can’t be trusted.
- Don’t guess. If you aren’t sure Google enforces something, say so and use the lowest severity.
- Write for a non-developer. Say what people see, not what the code calls it.
- Use your own words. Don’t paste Google’s policy text.
- Keep visitors’ data in their browser. A change that sends something new to a server needs a clear reason, and the privacy text must be updated to match.
Licence
The code is released under the PolyForm Noncommercial licence: free to read, run and improve for noncommercial use, and not free to sell or offer as a service. By contributing, you agree that your contribution is licensed under the same terms, that you have the right to contribute it, and that the project owner may also license it commercially.
Ready?
Pick the smallest thing you can do. It all helps.