From e617534aaa5a77cab314b5d9f600414382d1acf4 Mon Sep 17 00:00:00 2001 From: Carl von Blixen-Finecke Date: Wed, 20 Mar 2024 09:53:59 +0100 Subject: [PATCH] Add simple CONTRIBUTING.md (#1524) --- CONTRIBUTING.md | 8 ++++++++ README.md | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..1c4d188e5 --- /dev/null +++ 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 index bbb33f30d..a60cb6d5c 100644 --- 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