Skip to content

developing.md

Latest commit

 

History

History
37 lines (24 loc) · 987 Bytes

developing.md

File metadata and controls

37 lines (24 loc) · 987 Bytes

Development

Running Tests

Install dependencies and run all unit tests:

npm test

Formatting

This project uses Prettier to format code consistently. To format all files, run:

npm run format

Linting

This project uses ESLint with the eslint-plugin-jsdoc plugin to enforce JSDoc block tag formatting and an 80-character line length. To run linting:

npm run lint

Branch Naming

When creating pull request branches, this action uses the following naming convention:

codez-<type>-<issueNumber>-<short-description>
  • <type> is one of feat, fix, docs, styles, or chore, inferred from the commit message.
  • <issueNumber> is the related issue number.
  • <short-description> is a slugified version of the generated commit message (lowercase, spaces replaced with hyphens, and non-alphanumeric characters removed).