Contribute
TypeFast.io is open source under the MIT license. The codebase is small and well-structured, and pull requests are welcome on GitHub.
Ways to help
- Report bugs. Open an issue on GitHub with steps to reproduce, your browser and OS, and a screenshot if it's a visual issue. Reports that include reproduction steps are fixed much faster than "it doesn't work."
- Request features. Open an issue describing the problem you're trying to solve, not just the solution you have in mind. The behaviour you're imagining might already exist, or there might be a smaller change that gets you most of the way there.
- Add or improve word lists. Word and sentence lists live in the assets directory. PRs that add a new language or improve an existing one are particularly easy to review.
- Fix bugs and ship features. Pick an issue tagged
good first issueorhelp wantedand open a PR. For larger changes, comment on the issue first to align on approach before sinking time into a draft. - Improve the docs. If something on the how-it-works or tips pages is wrong or unclear, that's a doc fix worth submitting.
Local development
Under the hood this is a plain Angular application, nothing exotic. Clone the repo, run npm install, then npm start to spin up the Angular dev server at localhost:4200 with hot reload. npm run build produces a production bundle, and npm run lint runs ESLint and Prettier checks. The repo's README covers anything project-specific.
Style and formatting are enforced by ESLint and Prettier, so let the tools do the formatting rather than hand-tuning whitespace. There's a handful of unit tests for utilities; if your change covers logic that's worth testing, please add a spec next to the file you're touching.
