Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: create compass.yml #191

Merged
merged 1 commit into from
Oct 6, 2021
+20 −0
Merged

feat: create compass.yml #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/compass.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
rules:
- name: grahpql recommendations
check: true
skip: true
match: ["**/*.graphql"]
comment: |-
:warning:

You have modified the GraphQL schema. Please take this into account when modifying graphql schemas:

**When deleting fields**
- [ ] Marked the field as `@deprecated` instead of deleting it
**When adding new types**
- [ ] You have checked there is no naming conflicts
- [ ] You are using `PascalCase` for naming the types

:warning:

When you modify the GraphQL schema, we automatically generate a client library.
If you have modified types or queries and you have not updated the code handling it, the build step will fail.