From 05fcda639482b687ad3ef01455dc28523ac1b4ea Mon Sep 17 00:00:00 2001 From: Frazer Smith Date: Mon, 14 Mar 2022 12:08:54 +0000 Subject: [PATCH] docs: improve readability --- CONTRIBUTING.md | 8 ++++---- README.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6946831a..bf13083d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,13 +15,13 @@ Other processes and specifications that are in use in this repository are: ## Getting Started -This repository requires that you have [Node.js](https://nodejs.org) installed. +This repository requires that you have [Node.js](https://nodejs.org) >=12.0.0 installed. -With those in place, you can fork the repository, clone it, and then run `npm install` to install all development dependencies. +With that in place, you can fork the repository, clone it, and then run `npm install` to install all dependencies. ### Development Workflow -After cloning and installing all the dependencies, there are several commands available for local development: +After cloning the repository and installing all the dependencies, there are several commands available for local development: - `npm run lint` - Lints everything in src directory - `npm run jest` - Runs Jest over all tests in src directory @@ -41,7 +41,7 @@ Titles and headings should adhere to the [Associated Press (AP)](https://www.aps ## Pull Request Checklist -Prior to submitting a pull request back to the main repository, please make sure you have completed the following steps: +Before submitting a pull request back to the main repository, please make sure you have completed the following steps: 1. Pull request base branch is set to `master`. All pull requests should be forked from and merged back to `master` 2. Run `npm test` to check the code adheres to the defined ESLint style and that it passes the Jest tests diff --git a/README.md b/README.md index f2374e44..163d68dc 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,7 @@ poppler.pdfToText(file, options).then((res) => { Contributions are welcome, and any help is greatly appreciated! -See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to get started. +See [the contributing guide](./CONTRIBUTING.md) for details on how to get started. Please adhere to this project's [Code of Conduct](./CODE_OF_CONDUCT.md) when contributing. ## Acknowledgements