gh-lint - npm Package Compare versions

Comparing version 0.8.0 to 0.8.1

package.json

		{
		"name": "gh-lint",
		"version": "0.8.0",
		"version": "0.8.1",
		"description": "Rule-based command-line tool for auditing GitHub repositories",
		@@ -5,0 +5,0 @@ "main": "lib/execute/index.js",

README.md

		@@ -9,2 +9,25 @@ # gh-lint

		## Contents

		- [Install](#install)
		- [Usage](#usage)
		- [Rules](#rules)
		- [Repo rules](#repo-rules)
		- [Branch rules](#branch-rules)
		- [Commit rules](#commit-rules)
		- [PR rules](#pr-rules)
		- [Options](#options)
		- [Plugins](#plugins)
		- [License](#license)


		## Why gh-lint?

		When you agree on some development guidelines, you need to know when they are not followed.

		Most major open-source projects have adopted some automation to validate contribution guidelines. With gh-lint you can validate guidelines in public and private repositories across multiple organisations using pre-defined and custom rules.

		See the talk about the development guidelines and gh-lint at FullStack 2017: [video](https://skillsmatter.com/skillscasts/10399-auditing-development-guidelines-in-github-repositories) and [slides](https://www.slideshare.net/epoberezkin/auditing-development-guidelines-in-github-repositories).


		## Install
		@@ -27,3 +50,7 @@

		gh-lint can generate output in TAP format (with option `--tap`) that can be consumed by [tap-github-issues](https://github.com/MailOnline/tap-github-issues) to open, close and update issues in the GitHub repositories where the rules are checked.

		See [gh-lint-demo](https://github.com/MailOnline/gh-lint-demo) for the example configuration and the scripts to run gh-lint and tap-github-issues.


		## Rules
		@@ -30,0 +57,0 @@

New alerts