diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3126220f..f35395ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,9 +9,9 @@ When you submit pull requests, please make sure to fork from and submit back to Other processes and specifications that are in use in this repository are: -- [Semantic versioning](https://semver.org/) -- [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) following the [@commitlint/config-conventional config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) -- [Prettier](https://prettier.io/) style guide +- [Semantic versioning](https://semver.org/) +- [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) following the [@commitlint/config-conventional config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) +- [Prettier](https://prettier.io/) style guide ## Getting started @@ -24,16 +24,16 @@ Make a copy of `.env.template` in the root directory and rename it to `.env`, co After cloning the repository and installing all the dependencies, there are several commands available for local development: -- `npm run build` - Runs esbuild to compile code into dist directory -- `npm run lint` - Runs [ESLint](https://eslint.org) over all support file types -- `npm run lint:prettier` - Runs [Prettier](https://prettier.io) over all supported file types -- `npm run jest` - Runs [Jest](https://jestjs.io) tests in src directory -- `npm test` - Runs all of the above linting and testing scripts together -- `npm run start:dev` - Starts a development server with live reload +- `npm run build` - Runs esbuild to compile code into dist directory +- `npm run lint` - Runs [ESLint](https://eslint.org) over all support file types +- `npm run lint:prettier` - Runs [Prettier](https://prettier.io) over all supported file types +- `npm run jest` - Runs [Jest](https://jestjs.io) tests in src directory +- `npm test` - Runs all of the above linting and testing scripts together +- `npm run start:dev` - Starts a development server with live reload ### Production workflow -- `npm start` - Runs a production version. No live reload +- `npm start` - Runs a production version. No live reload ## Documentation style diff --git a/README.md b/README.md index 82586a91..478051c6 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,11 @@ Docsmith enables a data processor to use a comprehensive, GDPR-compliant, open-s These are only required if running the API outside of Docker: -- [Node.js](https://nodejs.org/en/) >=20.0.0 -- Linux only: `poppler-data` >=0.4.9 -- Linux only: `poppler-utils` >=20.12.0 -- macOS only: `poppler` >=20.12.0 -- Linux and macOS only: `unrtf` >=0.19.3 +- [Node.js](https://nodejs.org/en/) >=20.0.0 +- Linux only: `poppler-data` >=0.4.9 +- Linux only: `poppler-utils` >=20.12.0 +- macOS only: `poppler` >=20.12.0 +- Linux and macOS only: `unrtf` >=0.19.3 ## Setup @@ -59,9 +59,9 @@ Perform the following steps before deployment: > **Note** > Set the following environment variables in `.env` to meet NHS England's recommendation to retain six months' worth of logs: > -> - `LOG_ROTATION_DATE_FORMAT="YYYY-MM-DD"` -> - `LOG_ROTATION_FREQUENCY="daily"` -> - `LOG_ROTATION_MAX_LOGS="180d"` +> - `LOG_ROTATION_DATE_FORMAT="YYYY-MM-DD"` +> - `LOG_ROTATION_FREQUENCY="daily"` +> - `LOG_ROTATION_MAX_LOGS="180d"` ## Deployment