Skip to content

docs: add CONTRIBUTING.md #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"bumpVersionsWithWorkspaceProtocolOnly": true,
"ignore": []
}
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing

Thanks for contributing!

## Installation

```sh
git clone https://github.com/ota-meshi/eslint-plugin-svelte.git
cd eslint-plugin-svelte
yarn
```

## Running the tests

```sh
yarn test
```

To run the tests with debugging log, you can use `yarn test:debug`.

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.

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.

## Commit messages

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.

## Publishing

We're using [changesets](https://github.com/changesets/changesets) for version management, CHANGELOG and releasing automatically.

Please view [changesets-bot](https://github.com/apps/changeset-bot) and its [action](https://github.com/changesets/action) for more details.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@
"docs:build": "yarn svelte-kit build",
"docs:preview": "yarn svelte-kit preview",
"docs:watch": "yarn svelte-kit dev",
"eslint-fix": "eslint . --fix",
"format-for-gen-file": "eslint src/types-for-node.ts src/utils/rules.ts src/configs --fix",
"lint": "run-p lint:*",
"lint-fix": "yarn lint:es --fix && yarn lint:style --fix",
"lint:es": "eslint --cache -f friendly .",
"lint:style": "stylelint --cache .",
"mocha": "yarn ts ./node_modules/mocha/bin/mocha.js",
Expand Down