Skip to content

Commit ed620c6

Browse files
committed
Fix #17: why the data dir?
1 parent 2551bcb commit ed620c6

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

data/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Generated Data
2+
3+
Normally you wouldn't track generated data in git; however we deliberately keep these resources under version control:
4+
5+
- `schema.graphql` is compared during upgrades, migrations and pull requests so you can see what has changed and ensure there’s no accidental GraphQL regressions
6+
- `schema.sql` is kept for similar (but database) reasons, and to ensure that all developers are running the same version of the database without accidental differences caused by faulty migration hygeine
7+
- `schema.json` is used by various tooling (e.g. ESLint) to validate the GraphQL queries; technically we should probably just use schema.graphql for this 🤷‍♂️

0 commit comments

Comments
 (0)