Skip to content

Commit fa297e1

Browse files
authored
Create CONTRIBUTING.md
1 parent 817d15e commit fa297e1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributing
2+
3+
This plugin needs to run in as many environments as possible. Avoid modern constructs (e.g. `let`, `const`, `import`) in favor of older ones (e.g. `var`, `require`).
4+
5+
## Publishing
6+
7+
To publish a new version:
8+
9+
1. `npm version (major|minor|patch)`
10+
2. `git push --follow-tags`
11+
3. [Create a new release](https://github.com/cletusw/eslint-plugin-local-rules/releases/new) from the npm-created tag. Use the tag name for the "Release title" (e.g. "v2.0.0").
12+
4. The [npm-publish](.github/workflows/npm-publish.yml) GitHub Action will automatically run the tests then `npm publish` the new release to the NPM registry (https://www.npmjs.com/package/eslint-plugin-local-rules).

0 commit comments

Comments
 (0)