Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.36 KB
Raw

Development

To get started, ensure both Node v18.x or the latest LTS version and npm 8.x are installed, and then install the dependencies.

pnpm install
pnpm start

Tech Stack

  • Style - SCSS
  • State Management - NgRx
  • Frontend - Angular

Testing

Cypress is used for E2E tests.

pnpm run e2e

Jasmine and Karma are used for unit tests.

pnpm run test

Raising Pull Requests

  • Please keep the PRs small and focused on one thing
  • Link to an open issue. If one does not already exist, create it
  • Please follow the format of creating branches
    • feat/[feature name]: This branch should contain changes for a specific feature
      • Example: feat/new-chart
    • fix/[bug name]: This branch should contain only bug fixes for a specific bug
      • Example: fix/bug-1

Commit Message Format

All commit messages must adhere to the Conventional Commits standard, which is enforced by commitlint. (The styling of commit messages is enforced because the CHANGELOG is autogenerated by release-it.