itamargiv / data-grid Goto Github PK

Add a github workflow script to run checks before merging.

Acceptance Criteria:
A GitHub workflow is added, to run on all Pull Requests to develop or main that ensure that:

• Code is tested
• Code is Formatted
• Code is Linted
• Code and PR Title is Spell Checked
• PR title is conventional

Add step to generate documentation from JSDOC comments.

Acceptance Criteria:

• A script is added to generate a static documentation site from JSDOC comments
• Documentation site is deployed to GitHub Pages on each merge from release/ or hotfix/ into main.

Find a way to add a cross repository git hook to ensure code is formatted and commit messages / branching conventions are used.

Add mechanism to generate CHANGELOG entries and bump the software version by parsing conventional commit messages into a conventional change log standard such as 'Keep a CHANGELOG'.

This can be done with tools such as change to generate and tag, or semantic-release to take full control over the release process.

Acceptance Criteria:

• Scripts is added to prepare the next release of the software.
• Release is verified on each PR from release/ or hotfix/ branches into main.
• Optional: Release is executed on each merge into main.

Add ESLint to augment code formatting and run static analysis to detect code smells.

Acceptance Criteria:

• A linting script is available with the repository
• Changed files are linted before each commit
• All current linting violations are resolved

Add build step to ensure code is also available as ES5.

Acceptance Criteria:

• A script is included to transpile code from ESNext into ES5.