This repository has been archived by the owner on Aug 28, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
CONTRIBUTING
40 lines (31 loc) · 1.98 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Contributing
Contributions are welcome. We’re using [pnpm](https://pnpm.io/).
Install all dependencies:
`$ pnpm install`
Prepare the tests:
`$ pnpm test:prepare`
Run the tests:
`$ pnpm run dev`
Build all packages:
`$ pnpm run build`
We require a semantic PR title, e. g.:
```
docs: Add information about semantic commits
^ ^
| |__ Subject
|________ Prefix
```
Here are all the prefixes you need to know:
| Prefix | Description |
| -------- | ----------------------------------------------------------------------------------------------------------- |
| feat | A new feature |
| fix | A bug fix |
| docs | Documentation only changes |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| refactor | A code change that neither fixes a bug nor adds a feature |
| perf | A code change that improves performance |
| test | Adding missing tests or correcting existing tests |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| chore | Other changes that don't modify src or test files |
| revert | Reverts a previous commit |