Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
smyrick authored Nov 7, 2024
1 parent 32d6686 commit fa63933
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ financial support for the systems and people that power our community, please
also consider membership in the
[GraphQL Foundation](https://foundation.graphql.org/join).

## Adding spec examples
## Contributing to the spec text

### Adding spec examples

To keep things consistent in the spec, we should use examples that reference an e-commerce store. We should use types like `Product`, `User`, `Reviews`, etc.

### Adding new sections

Sections in the spec document are nested under top level sections, then topic sections, then specific sections. We should aim to limit to 3 nested levels and consider flattening once we reach 4 levels.

0 comments on commit fa63933

Please sign in to comment.