Skip to content

Commit 6a533f7

Browse files
committed
docs: add contribution guidelines
1 parent 461513e commit 6a533f7

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

contributing.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
Hello! It's great that you are interested in contributing to ESLint Plugin De Morgan. Before submitting your contribution, please take a moment to read the following guide:
4+
5+
## Installation
6+
7+
This project uses the [pnpm](https://pnpm.io) package manager. Therefore, to work with the project, you need to install it.
8+
9+
How to set up a project locally and run tests:
10+
11+
1. Clone repo:
12+
13+
```sh
14+
git clone [email protected]:azat-io/eslint-plugin-de-morgan.git
15+
```
16+
17+
2. Install dependencies:
18+
19+
```sh
20+
pnpm install
21+
```
22+
23+
3. Run tests:
24+
25+
```sh
26+
pnpm test
27+
```
28+
29+
## Pull Request Guidelines
30+
31+
Before create pull request fork this repo and create a new branch.
32+
33+
ESLint Plugin De Morgan aims to be lightweight, so think before adding new dependencies to your project.
34+
35+
Commit messages must follow the [commit message convention](https://conventionalcommits.org/) so that changelogs can be automatically generated.
36+
37+
Make sure tests pass.
38+
39+
## Additional information
40+
41+
This plugin uses [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser). When developing, I recommend using [AST explorer](https://ast-explorer.dev). It makes development much easier.

0 commit comments

Comments
 (0)