Skip to content

docs(readme): update contribution guidelines #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 15, 2025
Merged

docs(readme): update contribution guidelines #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,13 +288,15 @@ Contributions are welcome! To contribute:

2. **Fork the repository and create a feature branch.**

3. **Install dependencies**
3. **Ensure you have the _latest_ version of [pnpm](https://pnpm.io/installation) installed.**

4. **Install dependencies**

```bash
pnpm install
```

4. **Adhere to the code style**
5. **Adhere to the code style and lint rules**

```bash
pnpm lint:fix
Expand All @@ -304,19 +306,19 @@ Contributions are welcome! To contribute:
pnpm format
```

5. **Run tests**
6. **Run tests**

```bash
pnpm test
```

6. **Ensure type correctness**
7. **Ensure type correctness**

```bash
pnpm typecheck
```

7. **Submit a pull request with a clear description of your changes.**
8. **Submit a pull request with a clear description of your changes.**

## 👥 Contributors

Expand Down