# Developer Documentation

Thanks for taking the time to consider contributing to the project. You will find documentation here that will help you get a local environment setup for contributing to the project as well as some helpful guidance on how you can help keep `angular-fontawesome` going.

## Prerequisites

* [git](https://git-scm.com/downloads)
* [node 18+](https://nodejs.org/en/download/)

## Setting up the local environment

1. `git clone https://github.com/FortAwesome/angular-fontawesome`
1. `cd angular-fontawesome`
1. `corepack enable` - to get the global `yarn` command
1. `yarn` - install dependencies
1. `yarn build:watch` (in terminal 1) - build the library and keep watching for changes
1. `yarn start` (in terminal 2) - start sample application using library distribution from the previous step
1. Visit http://localhost:4200 and observe sample application running

## Make changes

1. Modify the code. You can use sample application from the previous step to check that your changes behave as intended.
2. Once you're done with the implementation add relevant tests and ensure that `yarn lint` and `yarn test` pass.
3. Submit a pull request.

## Development tasks

Development tasks are managed as `scripts` inside of `package.json`. Below are the description of the common tasks:

Command     | Purpose
---         | ---
`yarn format`        | Format codebase using Prettier
`yarn lint`        | Verify code style
`yarn test`        | Execute unit tests
`yarn test:schematics`        | Execute unit tests for schematics
`yarn test:demo`        | Execute unit tests of the demo project
`yarn test:integration`        | Execute integration tests
`yarn start`       | Run development server for the demo application
`yarn build`       | Build library
`yarn build:schematics`       | Build schematics (should be run after the library build)

## Releasing

1. Bump version in `package.json`
1. Update versions in `projects/schematics/src/ng-add/versions.cts` to align with the published release.
1. Add contributors to `README.md`
1. Update Compatibility table in `README.md` and `docs/guide/compatibility.md`
1. Update the `CHANGELOG.md`
1. Update the `UPGRADING.md` if necessary
1. `yarn build && yarn build:schematics`
1. `cd dist/angular-fontawesome`
1. `npm publish` - publish to public registry
1. `npm publish --registry https://npm.fontawesome.com` - publish to Pro registry
1. `git commit -a -m 'Release VERSION'`
1. `git tag <version> && git push upstream && git push upstream --tags` - create a tag and push all changes to GitHub
1. Create a [new release](https://github.com/FortAwesome/angular-fontawesome/releases/new) with CHANGELOG details
1. Update StackBlitz sample projects: [one](https://stackblitz.com/edit/angular-ivy-7jrcne) and [two](https://stackblitz.com/edit/angular-ivy-9mvggg)