Skip to content

Commit 860ef3a

Browse files
committed
docs: add contributing guide
1 parent 269dab0 commit 860ef3a

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

CONTRIBUTING.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing
2+
3+
Hi! I'm really excited that you are interested in contributing to Vorms. Before submitting your contribution, please make sure to take a moment and read through the following guide:
4+
5+
## Repo Setup
6+
7+
The Vorms repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/).
8+
9+
Here is a quick guide to doing code contributions to the library.
10+
11+
1. Fork and clone the repo to your local machine
12+
13+
```bash
14+
git clone https://github.com/YOUR_GITHUB_USERNAME/vorms.git
15+
```
16+
17+
```bash
18+
pnpm install
19+
```
20+
21+
2. Create a new branch from `master` with a meaningful name for a new feature or an issue you want to work on
22+
3. If you've added a code that should be tested, ensure the test suite still passes.
23+
24+
```bash
25+
pnpm test
26+
```
27+
28+
Try to write some unit tests to cover as much of your code as possible.
29+
30+
4. Ensure your code lints without errors
31+
32+
```bash
33+
pnpm lint
34+
```
35+
36+
5. Ensure build passes.
37+
38+
**@vorms/core**
39+
40+
```bash
41+
pnpm build:core
42+
```
43+
44+
**@vorms/resolvers**
45+
46+
```bash
47+
pnpm build:resolvers
48+
```
49+
50+
6. Push your branch.
51+
7. Submit a pull request to the upstream vorms repository.
52+
8. Choose a descriptive title and describe your changes briefly.
53+
54+
## Coding style
55+
56+
Please follow the coding style of the project. Vorms uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback. The linting can be run manually with the following command: `pnpm lint` and `pnpm format`

0 commit comments

Comments
 (0)