Skip to content

Commit

Permalink
docs: Add contributing docs (#173)
Browse files Browse the repository at this point in the history
  • Loading branch information
mskelton authored Oct 22, 2023
1 parent e11113e commit 2927305
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# Contributing

## Installing Dependencies

We use [pnpm](https://pnpm.io) for managing dependencies. You can install the
necessary dependencies using the following command:

```bash
pnpm install
```

## Running Tests

When making changes to lint rules, you can re-run the tests with the following
command:

```bash
pnpm test
```

Or run it in watch mode like so:

```bash
pnpm test -- --watch
```

## Adding new rules

When adding new rules, make sure to follow these steps:

1. Add the rule source code in `src/rules`
1. Add tests for the rule in `test/spec`
1. Add docs for the rule to `docs/rules`
1. Add a short description of the rule in `README.md`

## Releasing

To release a new version with semantic-release, run the following command.
Expand Down

0 comments on commit 2927305

Please sign in to comment.