File tree Expand file tree Collapse file tree 1 file changed +66
-0
lines changed Expand file tree Collapse file tree 1 file changed +66
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing to Sanity App SDK
2+
3+ ## Table of Contents
4+
5+ - [ Getting Started] ( #getting-started )
6+ - [ Setup] ( #setup )
7+ - [ Testing] ( #testing )
8+ - [ Contributing] ( #contributing )
9+
10+ ## Getting Started
11+
12+ Before contributing, please read our [ code of conduct] ( https://github.com/sanity-io/.github/blob/main/CODE_OF_CONDUCT.md ) .
13+
14+ ### Prerequisites
15+
16+ - Node.js: Version 20.x or higher (we recommend using the LTS version)
17+ - pnpm: Version 8.x or higher
18+
19+ Check your versions:
20+
21+ ``` bash
22+ node --version
23+ pnpm --version
24+ ```
25+
26+ ## Setup
27+
28+ 1 . Clone the repository
29+
30+ ``` bash
31+ git clone
[email protected] :sanity-io/sdk.git
32+ ```
33+
34+ 2 . Install dependencies
35+
36+ ``` bash
37+ pnpm install
38+ ```
39+
40+ 3 . Run locally
41+
42+ ``` bash
43+ pnpm run dev
44+ ```
45+
46+ ## Testing
47+
48+ Run tests locally before submitting:
49+
50+ ``` bash
51+ pnpm test
52+ ```
53+
54+ ## Contributing
55+
56+ ### Branch Guidelines
57+
58+ We follow the [ Conventional Branch] ( https://conventional-branch.github.io/ ) specification.
59+
60+ ### Commit Guidelines
61+
62+ We follow the [ Conventional Commits] ( https://www.conventionalcommits.org/ ) specification.
63+
64+ ### Pull Request Process
65+
66+ Please follow the [ Pull Request Template] ( .github/PULL_REQUEST_TEMPLATE.md ) when submitting code for review.
You can’t perform that action at this time.
0 commit comments