From 80071d3508422320430f94219c6e7cbf5ec3d82d Mon Sep 17 00:00:00 2001
From: Brandon Wilson <brandon@coil.com>
Date: Tue, 14 Mar 2023 09:07:15 -0500
Subject: [PATCH] chore(docs): document graphql-codegen script (#1213)

* chore(docs): document graphql-codegen script

* chore(docs): reference codegen.yml
---
 .github/contributing.md | 14 ++++++++++++++
 README.md               |  3 +++
 2 files changed, 17 insertions(+)

diff --git a/.github/contributing.md b/.github/contributing.md
index be7602bab1..4f1fb23caf 100644
--- a/.github/contributing.md
+++ b/.github/contributing.md
@@ -96,6 +96,20 @@ Eslint config should not be overridden in any packages.
 
 Prettier config should not be overridden in any packages.
 
+#### GraphQL type generation
+
+[GraphQL Code Generator](https://the-guild.dev/graphql/codegen) is used for generating TypeScript types from `schema.graphql` files.
+
+```shell
+./<package>/codegen.yml # GraphQL Code Generator config
+```
+
+The `generate` script should be run if a package's `schema.graphql` file is modified.
+
+```shell
+pnpm --filter <package> generate
+```
+
 #### Testing
 
 [Jest](https://jestjs.io/) is used for testing.
diff --git a/README.md b/README.md
index 3f6817a466..c4d6383929 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,9 @@ pnpm -r build
 # build specific package (e.g. backend):
 pnpm --filter backend build
 
+# generate types from specific package GraphQL schema:
+pnpm --filter backend generate
+
 # run individual tests (e.g. backend)
 pnpm --filter backend test