Add simple CONTRIBUTING.md (#1524)

maticzav · Mar 20, 2024 · e617534 · e617534
1 parent 6ac877e
commit e617534
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,8 @@
+# Contributing to graphql-shield
+
+## Development setup
+
+1. [Fork](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#forking-a-repository) and [clone](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#cloning-a-fork) this repository.
+1. [Install pnpm](https://pnpm.io/installation).
+1. Run `pnpm install`.
+1. Run `pnpm test`. All tests should pass.
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 
 ## Contributing
 
-We are always looking for people to help us grow `graphql-shield`! If you have an issue, feature request, or pull request, let us know!
+We are always looking for people to help us grow `graphql-shield`! If you have an issue, feature request, or pull request, let us know! For information about development setup and more, see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License