ShaneTaylor.dev

This project was generated with Angular CLI.

Commit Messages

Conventions

This repository follows the Conventional Changelog to commit code.

The commit message header consists of the following and cannot be any longer than 72 characters: <type>(<scope>):<subject>

Where type is required and must be one of the following:

'build' 'chore' 'deploy' 'docs' 'feat' 'fix' 'perf' 'refactor' 'revert' 'test'

Subject is mandatory and is a succinct description of the change.

The scope, body, and footer are optional and CAN contain numbers.

Example 1: commit message:

feat(charts): implement mock chart data

Implement mock chart data for github service

Closes issue 123

Important!

Only commit messages of type feat, fix, perf and chore will be shown in the release notes (changelog).

Only the type, the scope and the subject is shown in the release notes (changelog).

Pre Hooks

When a commit is made, we use Husky to check only the staged files with eslint, eclint, and run the unit tests. If any of these stages fail, the commit will fail. Please correct the issues and run the commit again. If you really want to just do the commit without these checks, simply run the commit with the flag --no-verify.

Plugins

We use Prettier for formatting and linting of our files to maintain consistency and readability. Please install as this is REQUIRED.

• Prettier

It is recommended that you use VSCode along with the following plugins, for the best developer experience and avoid reformats happening when running pre commit hooks:

• Angular Language Service
• Code Metrics
• GitLens
• Todo Tree

Creating a new release

For a new release

• npx standard-version
• git push --follow-tags origin main

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.