CONTRIBUTING.md

Contributing to Doubtfire Web

We welcome additions and extensions to Doubtfire that help progress our goal of supporting student learning through frequent formative feedback and delayed summative assessment.

This guide provides high-level details on how to contribute to the Doubtfire Web repository.

Before continuing, please read the contributing document, as this outlines the Git workflow you should be following.

Table of Contents

• Contributing to Doubtfire Web
  • Table of Contents
  • Project structure
  • Testing
  • Formatting
  • Migrating components

Project structure

Coming...

Testing

After installing all the dependencies, to run the front-end Angular tests, run the following command:

npm test

Formatting

• [ESLint] is used in the project to enforce code style and should be configured in your editor.
• [Prettier] is also used and apply automatically by ESLint.

We also use a number of framework plugins:

• [TypeScript ESLint]
• [Angular ESLint]

You can check this manually by running:

npm run lint

You can ask ESLint to fix issues by running:

npm run lint:fix

Please note that not all issues can be fixed by ESLint and Prettier.

Migrating components

See MIGRATION-GUIDE.md

ESLint Prettier TypeScript ESLint Angular ESLint