Skip to content

Commit

Permalink
add contributing guide (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
yukukotani committed Aug 20, 2022
1 parent 3ebb85a commit eea8cf7
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Any contributions are welcome.

## Setup

This project uses [pnpm](https://pnpm.io/installation). Please install it if you haven't.

Then install dependencies to finish the setup.

```
pnpm install
```

## Development

- `pnpm test` to run tests.
- `pnpm lint` to run linting and type-checking.
- `pnpm build` to build.

## Maintainers

Feel free to mention them if you have questions.

- [@yukukotani](https://github.com/yukukotani)
- (Inactive) [@no-yan](https://github.com/no-yan)
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ Every rule is fixable with `eslint --fix`.
- [`props-shorthand`](https://github.com/yukukotani/eslint-plugin-chakra-ui/blob/main/docs/rules/props-shorthand.md): Enforces the usage of shorthand property or vice-versa
- [`require-specific-component`](https://github.com/yukukotani/eslint-plugin-chakra-ui/blob/main/docs/rules/require-specific-component.md): Enforces the usage of specific Chakra components instead of Box components with an attribute.

## Contributing

See [contributing guide](CONTRIBUTING.md).

## Prior Art

This plugin is inspired by [eslint-plugin-tailwind-css](https://github.com/francoismassart/eslint-plugin-tailwindcss).

0 comments on commit eea8cf7

Please sign in to comment.