Skip to content

Commit 4dbfd8e

Browse files
authored
Update CONTRIBUTING.md
1 parent 2632211 commit 4dbfd8e

1 file changed

Lines changed: 1 addition & 39 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Contributing
22

3-
## Development Setup
4-
53
- **Node.js**: Version 22 or higher
64
- Use a Node.js version manager compatible with `.node-version` ([asdf-vm](https://asdf-vm.com) is a great option for macOS/Linux users)
5+
- Use pnpm packet manager
76

87
```bash
98
# Clone the SolidStart repository
@@ -25,11 +24,6 @@ pnpm install
2524
pnpm build
2625
```
2726

28-
<details>
29-
<summary>
30-
<h4>Monorepo & <code>package.json</code> <code>"workspaces"</code> Support</h4>
31-
</summary>
32-
3327
If you are using SolidStart within a monorepo that takes advantage of the `package.json` `"workspaces"` property (e.g. [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces)) with hoisted dependencies (the default for Yarn), you must include `@solidjs/start` within the optional `"nohoist"` (for Yarn v2 or higher, see further down for instructions) workspaces property.
3428

3529
- _In the following, "workspace root" refers to the root of your repository, while "project root" refers to the root of a child package within your repository._
@@ -75,35 +69,3 @@ The `nohoist` option is no longer available in Yarn v2+. In this case, we can us
7569
}
7670
}
7771
```
78-
79-
</details>
80-
81-
## Contributing Workflow
82-
83-
1. **Make Changes**
84-
Implement changes and follow the project structure (e.g. tests in the `test` directory).
85-
86-
2. **Add Tests**
87-
Add tests in the `test` directory if appropriate.
88-
89-
3. **Run Tests Locally**
90-
91-
```bash
92-
# Install Playwright for testing
93-
pnpm run install:playwright
94-
```
95-
96-
```bash
97-
# Run all tests
98-
pnpm run test:all
99-
```
100-
101-
```bash
102-
# View test report
103-
pnpm run show:test-report
104-
```
105-
106-
4. **Submit a Pull Request**
107-
- Use [Conventional Commits](https://www.conventionalcommits.org) for clear, concise commit messages
108-
- Reference related issues in the PR description
109-
- Ensure tests pass and code is formatted with [Prettier](https://prettier.io/)

0 commit comments

Comments
 (0)