Skip to content
This repository was archived by the owner on Feb 9, 2023. It is now read-only.

Commit 2a285f9

Browse files
authored
Add contributing (#34)
1 parent 06fd407 commit 2a285f9

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Thank you for wanting to contribute. This parser is essential to stylelint's built-in support of CSS-in-JS.
4+
5+
We want to encourage contributions! If you want to participate but couldn't, please [give us feedback](https://github.com/stylelint/postcss-css-in-js/issues/new) about what we could do better.
6+
7+
## Code contributions
8+
9+
To start coding, you'll need:
10+
11+
- a minimum of [Node.js](https://nodejs.org/en/) v10, though we do recommend using the latest LTS release
12+
- the latest [npm](https://www.npmjs.com/)
13+
14+
Then:
15+
16+
1. [Fork and clone](https://guides.github.com/activities/forking/) this repository.
17+
2. Install all the dependencies with `npm ci`.
18+
19+
### Run tests
20+
21+
Next, you'll want to run the tests using `npm test`.
22+
23+
However, this runs the test just once.
24+
25+
You can use `npm run watch` instead. It will run the tests when you change a file.
26+
27+
Additionally, you can run linting checks with `npm run lint`.
28+
29+
### Format code
30+
31+
We use [Prettier](https://prettier.io/) (with [a Husky and lint-staged precommit](https://prettier.io/docs/en/precommit.html)) to format your code automatically.
32+
33+
Alternatively, you can:
34+
35+
- trigger the pretty-printing all the files using `npm run format`
36+
- use a [Prettier editor integration](https://prettier.io/docs/en/editors.html)
37+
38+
### Open a pull request
39+
40+
When you have something to share, it's time to [open a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
41+
42+
After we review and merge your pull request, we'll invite you to become a maintainer of the stylelint organization. You'll then be able to work on the repository directly rather than your fork.

0 commit comments

Comments
 (0)