CONTRIBUTING.md

Contributing

Table of Contents

• Test
• Lint
• Release

All pull requests are welcome! By participating in this project, you agree to abide by our code of conduct.

Fork, then clone the repository:

# replace `<user>` with your username
git clone [email protected]:<user>/html-react-parser.git && cd html-react-parser

Install package dependencies:

npm install

Make your change. Add tests and/or documentation. Ensure all tests and lint pass:

npm test
npm run lint
npm run lint:dts

Write a commit message that follows the Conventional Commits specification.

The commit message will be linted during the pre-commit Git hook. To manually lint the most recent commit message:

git log -1 --pretty=format:"%s" | npx commitlint

Push to your fork and submit a pull request.

At this point you're waiting on us. We like to comment on pull requests within three business days (and, typically, one business day). We may suggest changes, improvements, or alternatives.

Things that will improve the chance that your pull request will be accepted:

• Write tests that pass CI.
• Write good documentation.
• Write a good commit message.

Test

Run tests with coverage:

npm test

View coverage report in your browser:

open coverage/lcov-report/index.html

Lint

Lint codebase:

npm run lint

Fix lint errors:

npm run lint:fix

Test TypeScript declaration files for style and correctness:

npm run lint:dts

Release

Release is automated with Release Please.