Commit 55c7e68

committed

docs: update contribution guidelines in README

- Clarified installation steps for pnpm - Updated numbering for contribution steps Signed-off-by: J3m5 <5523410+J3m5@users.noreply.github.com>

1 parent d718a1f commit 55c7e68Copy full SHA for 55c7e68

File tree

-5

lines changed

-5

lines changed

Lines changed: 7 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -288,13 +288,15 @@ Contributions are welcome! To contribute:`
`288`	`288`
`289`	`289`	`2. Fork the repository and create a feature branch.`
`290`	`290`
`291`		`-3. Install dependencies`
	`291`	`+3. Ensure you have the _latest_ version of [pnpm](https://pnpm.io/installation) installed.`
	`292`	`+`
	`293`	`+4. Install dependencies`
`292`	`294`
`293`	`295`	```bash
`294`	`296`	`pnpm install`
`295`	`297`	```
`296`	`298`
`297`		`-4. Adhere to the code style`
	`299`	`+5. Adhere to the code style and lint rules`
`298`	`300`
`299`	`301`	```bash
`300`	`302`	`pnpm lint:fix`
`@@ -304,19 +306,19 @@ Contributions are welcome! To contribute:`
`304`	`306`	`pnpm format`
`305`	`307`	```
`306`	`308`
`307`		`-5. Run tests`
	`309`	`+6. Run tests`
`308`	`310`
`309`	`311`	```bash
`310`	`312`	`pnpm test`
`311`	`313`	```
`312`	`314`
`313`		`-6. Ensure type correctness`
	`315`	`+7. Ensure type correctness`
`314`	`316`
`315`	`317`	```bash
`316`	`318`	`pnpm typecheck`
`317`	`319`	```
`318`	`320`
`319`		`-7. Submit a pull request with a clear description of your changes.`
	`321`	`+8. Submit a pull request with a clear description of your changes.`
`320`	`322`
`321`	`323`	`## 👥 Contributors`
`322`	`324`

Comments

(0)