Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.69 KB

Contributing to Ordinary Puzzles

PRs are welcome. When submitting a PR, please consider the following:

  • We require tests and will most likely reject a PR if there are no tests.

  • We are using TypeScript and all development should be done in TypeScript.

  • This project uses ESLint for linting and Prettier for formatting. See more below.

Running Ordinary Puzzles

  1. Setup the project by running npm run install.
  2. Disable the Averta font by setting _useAvertaFont to false in src/op-config/constants.ts.
  3. Run npm run ios to run the app on iOS, npm run android to run the app on Android, or npm run web to run the app on the web.

That's it! 🎉

Testing

Ordinary Puzzles is being tested with Jest.
For running the tests, run npm run test:watch to test as you develop, or npm run test for a single run.

Linting

This project uses ESLint with a simple preset of rules used by Create-React-App.
This ESLint setup also includes a standard Prettier configuration that handles the code formatting.
The code is automatically formatted before each commit (see the lint-staged section in the package.json for more details).
We suggest to enable the formatting on save feature of your editor of choice. If you use VSCode it will be already enabled by default while working on this project (see the .vscode directory included in the project).
To manually invoke the linter you can run npm run lint.