		# Contributing

		[![Build Status](https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/readability/master/badge.svg)](https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/readability/master/latest)
		Thank you for wanting to help make `readability` better!

		@@ -11,4 +11,10 @@ For outstanding issues, see the issue list in this repo, as well as this [bug list](https://bugzilla.mozilla.org/buglist.cgi?component=Reader%20Mode&product=Toolkit&bug_status=__open__&limit=0).

		This repository is governed by Mozilla's code of conduct and etiquette guidelines.
		For more details, please read the
		[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/).

		## Tests

		[![Build Status](https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/readability/master/badge.svg)](https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/readability/master/latest)

		Please run [eslint](http://eslint.org/) as a first check that your changes are valid JS and adhere to our style guidelines:
		@@ -45,12 +51,2 @@

		## Benchmarks

		Benchmarks for all test pages:

		$ npm run perf

		Reference benchmark:

		$ npm run perf-reference

		## Pull Requests
		@@ -68,9 +64,9 @@

		1. Ensure [CHANGELOG.md](CHANGELOG.md) is up-to-date. ``git log v`npm view . version`...master `` may help with this.
		1. Ensure [CHANGELOG.md](CHANGELOG.md) is up-to-date. ``git log `npm view . version`...master `` may help with this.
		2. Run `npm run release` to create a release, which should:
		2a. `npm version [patch \| minor \| major]`, depending on the nature of the changes according to
		1. `npm version [patch \| minor \| major]`, depending on the nature of the changes according to
		[semver](https://semver.org/). This will bump the version in `package.json` and `package-lock.json`
		and create a commit and Git tag for the release.
		2b. `npm publish` to push the release to the npm registry.
		2c. `git push origin head --follow-tags` to push the new commit and tag to GitHub.
		2. `npm publish` to push the release to the npm registry.
		3. `git push origin head --follow-tags` to push the new commit and tag to GitHub.

		@@ -77,0 +73,0 @@ ## Keeping a changelog

package.json

		{
		"name": "@mozilla/readability",
		"version": "0.4.0",
		"version": "0.4.1",
		"description": "A standalone version of the readability library used for Firefox Reader View.",
		"main": "index.js",
		"types": "index.d.ts",
		"scripts": {
		@@ -10,4 +11,2 @@ "lint": "eslint .",
		"generate-testcase": "node test/generate-testcase.js",
		"perf": "matcha benchmarks/benchmarks.js",
		"perf-reference": "READABILITY_PERF_REFERENCE=1 matcha --reporter ./benchmarks/benchmark-reporter.js benchmarks/benchmarks.js",
		"release": "release-it"
		@@ -35,3 +34,2 @@ },
		"jsdom": "^13.1",
		"matcha": "^0.6.0",
		"mocha": "^8.2.0",
		@@ -38,0 +36,0 @@ "release-it": "^14.2.2",

Readability.js

Sorry, the diff of this file is too big to display

@mozilla/readability - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics