docs: add contributing

rnmjs · May 1, 2024 · e088fb3 · e088fb3
1 parent 653bc2e
commit e088fb3
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/packages/tscx/README.md b/packages/tscx/README.md
@@ -5,7 +5,7 @@
 [![](https://img.shields.io/npm/dm/@rnm/tscx.svg)](https://www.npmjs.com/package/@rnm/tscx)
 [![](https://img.shields.io/librariesio/release/npm/@rnm/tscx)](https://www.npmjs.com/package/@rnm/tscx)
 [![](https://packagephobia.com/badge?p=@rnm/tscx)](https://packagephobia.com/result?p=@rnm/tscx)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/rnmjs/tscx?tab=readme-ov-file#contributing)
 
 A `tsc` wrapper with many convenient features. Bring the [nodemon](https://www.npmjs.com/package/nodemon) + JavaScript development experience to TypeScript.
 
@@ -60,6 +60,13 @@ $ npx tscx --project tsconfig.build.json --watch --exec bootstrap.js
 $ npx tscx --project tsconfig.build.json --remove --copyfiles --watch --script my-script --exec bootstrap.js
 ```
 
+## Contributing
+
+- Clone this repository.
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`.
+- Install dependencies using `pnpm install`.
+- Run `pnpm build` to build and `pnpm test` to test.
+
 ## License
 
 MIT