Contribute
Help make these tools better
Bug reports, fixes and ideas are all welcome. Here's how to send each one so it reaches the right place.
Part 1 Report a bug
Open an issue in the project's repository on GitHub. Search the existing issues first, because someone may already be working on it. Say what you did, what you expected and what happened instead.
Part 2 Send a fix
- 2.1Ask first
- Open an issue before a large pull request. Our projects keep a narrow scope on purpose, and asking first can save you building something we'd have to decline.
- 2.2One change at a time
- Keep each pull request to one change, and explain why it's needed. Add or update tests for anything you add or fix.
- 2.3Run the checks
- Run the project's check script before you open it. In our TypeScript projects that's
npm run check, which runs the same steps as CI. - 2.4Code style
- TypeScript in strict mode, Prettier for formatting and Canadian spelling in anything people read. Our ESLint config checks the rest, such as full-word names and braces on every
if. - 2.5Merging
- We squash or rebase pull requests when we merge them, so you don't need to tidy your commit history. Your contribution is released under the repository's licence, as GitHub's terms of service set out.
Part 3 Security problems
Please never report a security problem in a public issue. Our security policy explains how to report it privately.
Part 4 Code of conduct
Everyone taking part in an issue, pull request or discussion is expected to follow our code of conduct.
Part 5 Is something down?
Our status page tracks the hosted apps and the accessibility widget script, and shows when it last checked them.