Skip to content

Commit 4499881

Browse files
committed
Docs: add semantic versioning policy (fixes #41)
1 parent 4d9d009 commit 4499881

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# eslint-plugin-node
22

33
[![npm version](https://img.shields.io/npm/v/eslint-plugin-node.svg)](https://www.npmjs.com/package/eslint-plugin-node)
4-
[![Downloads/month](https://img.shields.io/npm/dm/eslint-plugin-node.svg)](https://www.npmjs.com/package/eslint-plugin-node)
4+
[![Downloads/month](https://img.shields.io/npm/dm/eslint-plugin-node.svg)](http://www.npmtrends.com/eslint-plugin-node)
55
[![Build Status](https://travis-ci.org/mysticatea/eslint-plugin-node.svg?branch=master)](https://travis-ci.org/mysticatea/eslint-plugin-node)
66
[![Coverage Status](https://coveralls.io/repos/mysticatea/eslint-plugin-node/badge.svg?branch=master)](https://coveralls.io/r/mysticatea/eslint-plugin-node?branch=master)
77
[![Dependency Status](https://david-dm.org/mysticatea/eslint-plugin-node.svg)](https://david-dm.org/mysticatea/eslint-plugin-node)
@@ -50,6 +50,27 @@ Some rules are slow because it searches `package.json` and opens it.
5050
- [process-exit-as-throw](docs/rules/process-exit-as-throw.md) - Make the same code path as throw at `process.exit()`. (⚠ Experimental)
5151
- [shebang](docs/rules/shebang.md) - Suggest correct usage of shebang. (fixable)
5252

53+
## Semantic Versioning Policy
54+
55+
`eslint-plugin-node` follows [semantic versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
56+
57+
- Patch release (intended to not break your lint build)
58+
- A bug fix in a rule that results in `eslint-plugin-node` reporting fewer errors.
59+
- Improvements to documentation.
60+
- Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage.
61+
- Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).
62+
- Minor release (might break your lint build)
63+
- A bug fix in a rule that results in `eslint-plugin-node` reporting more errors.
64+
- A new rule is created.
65+
- A new option to an existing rule is created.
66+
- An existing rule is deprecated.
67+
- Major release (likely to break your lint build)
68+
- A support for old Node version is dropped.
69+
- A support for old ESLint version is dropped.
70+
- An existing rule is removed.
71+
- An existing option of a rule is removed.
72+
- An existing config is updated.
73+
5374
## FAQ
5475

5576
Q: The `no-missing-import` / `no-missing-require` rules don't work with nested folders in SublimeLinter-eslint

0 commit comments

Comments
 (0)