Skip to content

Commit 3362ad4

Browse files
authored
docs: add CONTRIBUTING.md (#223)
close #222
1 parent 0543166 commit 3362ad4

File tree

3 files changed

+35
-1
lines changed

3 files changed

+35
-1
lines changed

.changeset/config.json

+1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@
1111
"access": "restricted",
1212
"baseBranch": "main",
1313
"updateInternalDependencies": "patch",
14+
"bumpVersionsWithWorkspaceProtocolOnly": true,
1415
"ignore": []
1516
}

CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
3+
Thanks for contributing!
4+
5+
## Installation
6+
7+
```sh
8+
git clone https://github.com/ota-meshi/eslint-plugin-svelte.git
9+
cd eslint-plugin-svelte
10+
yarn
11+
```
12+
13+
## Running the tests
14+
15+
```sh
16+
yarn test
17+
```
18+
19+
To run the tests with debugging log, you can use `yarn test:debug`.
20+
21+
This is an [ESLint](http://eslint.org) plugin. Documentation for the APIs that it uses can be found on ESLint's [Working with Plugins](http://eslint.org/docs/developer-guide/working-with-plugins) page.
22+
23+
This plugin is used to lint itself. The style is checked when `yarn lint` is run, and the build will fail if there are any linting errors. You can use `yarn lint-fix` to fix some linting errors.
24+
25+
## Commit messages
26+
27+
Please view [commitlint](https://commitlint.js.org) and [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) for more details.
28+
29+
## Publishing
30+
31+
We're using [changesets](https://github.com/changesets/changesets) for version management, CHANGELOG and releasing automatically.
32+
33+
Please view [changesets-bot](https://github.com/apps/changeset-bot) and its [action](https://github.com/changesets/action) for more details.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434
"docs:build": "yarn svelte-kit build",
3535
"docs:preview": "yarn svelte-kit preview",
3636
"docs:watch": "yarn svelte-kit dev",
37-
"eslint-fix": "eslint . --fix",
3837
"format-for-gen-file": "eslint src/types-for-node.ts src/utils/rules.ts src/configs --fix",
3938
"lint": "run-p lint:*",
39+
"lint-fix": "yarn lint:es --fix && yarn lint:style --fix",
4040
"lint:es": "eslint --cache -f friendly .",
4141
"lint:style": "stylelint --cache .",
4242
"mocha": "yarn ts ./node_modules/mocha/bin/mocha.js",

0 commit comments

Comments
 (0)