Skip to content

Commit

Permalink
Apply comments from WG meeting
Browse files Browse the repository at this point in the history
  • Loading branch information
smyrick committed Nov 7, 2024
1 parent fa63933 commit d261c81
Show file tree
Hide file tree
Showing 5 changed files with 402 additions and 1,332 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
.*.haste_cache.*
.DS_Store
npm-debug.log
yarn.lock
.idea
/build
/public
/gh-pages
/node_modules
SPECIFICATION.html
SPECIFICATION.html
20 changes: 18 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,28 @@ financial support for the systems and people that power our community, please
also consider membership in the
[GraphQL Foundation](https://foundation.graphql.org/join).

## Running a new build

- Install the latest version of Node and NPM
- Install the Node dependencies with `npm install`
- Build a new spec with `npm run build`
- This will output the new spec text in `/public` as HTML files

## Contributing to the spec text

### Auto-Formatting

The specification is formatted using the `prettier` tool, so you should not need
to think about gaps between paragraphs and titles, nor about word wrapping -
this is handled for you.

### 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.
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.
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.
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,16 @@ specification as well.

### Contributing to this repo

This repository is managed by EasyCLA. Project participants must sign the free
([GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org)
before making a contribution. You only need to do this one time, and it can be
signed by
[individual contributors](https://individual-spec-membership.graphql.org) or
their [employers](https://corporate-spec-membership.graphql.org).

To initiate the signature process please open a PR against this repo. The
EasyCLA bot will block the merge if we still need a membership agreement from
you.

You can find
[detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership).
If you have issues, please email
[[email protected]](mailto:[email protected]).

If your company benefits from GraphQL and you would like to provide essential
financial support for the systems and people that power our community, please
also consider membership in the
[GraphQL Foundation](https://foundation.graphql.org/join).
See more in [CONTRIBUTING.md](CONTRIBUTING.md) about contributing spec changes.
If you want to start a general discussion or concern, please
[open an issue](https://github.com/graphql/composite-schemas-spec/issues).

If you would like to attend a meeting to discuss the spec or an issue, see the
separate
[Composite Schemas Working Group repository](https://github.com/graphql/composite-schemas-wg).

- **Watch the replay of previous meetings:**
[Composite Schemas Working Group Meetings on YouTube](https://www.youtube.com/playlist?list=PLP1igyLx8foFjxyTg6wPn4pUkZwuAk2GR)

---

Expand Down
Loading

0 comments on commit d261c81

Please sign in to comment.