Skip to content

Commit 8e969bf

Browse files
authored
Create CONTRIBUTING.md (#56)
1 parent 72161a5 commit 8e969bf

File tree

4 files changed

+434
-31
lines changed

4 files changed

+434
-31
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
.*.haste_cache.*
44
.DS_Store
55
npm-debug.log
6+
yarn.lock
7+
.idea
68
/build
79
/public
810
/gh-pages
911
/node_modules
10-
SPECIFICATION.html
12+
SPECIFICATION.html

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing
2+
3+
## Contributing to this repo
4+
5+
This repository is managed by EasyCLA. Project participants must sign the free
6+
[GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org)
7+
before making a contribution. You only need to do this one time, and it can be
8+
signed by
9+
[individual contributors](https://individual-spec-membership.graphql.org) or
10+
their [employers](https://corporate-spec-membership.graphql.org).
11+
12+
To initiate the signature process please open a PR against this repo. The
13+
EasyCLA bot will block the merge if we still need a membership agreement from
14+
you.
15+
16+
You can find
17+
[detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership).
18+
If you have issues, please email
19+
[operations@graphql.org](mailto:operations@graphql.org).
20+
21+
If your company benefits from GraphQL and you would like to provide essential
22+
financial support for the systems and people that power our community, please
23+
also consider membership in the
24+
[GraphQL Foundation](https://foundation.graphql.org/join).
25+
26+
## Running a new build
27+
28+
- Install the latest version of Node and NPM
29+
- Install the Node dependencies with `npm install`
30+
- Build a new spec with `npm run build`
31+
- This will output the new spec text in `/public` as HTML files
32+
33+
## Contributing to the spec text
34+
35+
### Auto-Formatting
36+
37+
The specification is formatted using the `prettier` tool, so you should not need
38+
to think about gaps between paragraphs and titles, nor about word wrapping -
39+
this is handled for you.
40+
41+
### Adding spec examples
42+
43+
To keep things consistent in the spec, we should use examples that reference an
44+
e-commerce store. We should use types like `Product`, `User`, `Review`, etc.
45+
46+
### Adding new sections
47+
48+
Sections in the spec document are nested under top level sections, then topic
49+
sections, then specific sections. We should aim to limit to 3 nested levels and
50+
consider flattening once we reach 4 levels.

README.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,16 @@ https://graphql.github.io/composite-schemas-spec/.
1414

1515
### Contributing to this repo
1616

17-
This repository is managed by EasyCLA. Project participants must sign the free
18-
([GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org)
19-
before making a contribution. You only need to do this one time, and it can be
20-
signed by
21-
[individual contributors](https://individual-spec-membership.graphql.org) or
22-
their [employers](https://corporate-spec-membership.graphql.org).
23-
24-
To initiate the signature process please open a PR against this repo. The
25-
EasyCLA bot will block the merge if we still need a membership agreement from
26-
you.
27-
28-
You can find
29-
[detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership).
30-
If you have issues, please email
31-
[operations@graphql.org](mailto:operations@graphql.org).
32-
33-
If your company benefits from GraphQL and you would like to provide essential
34-
financial support for the systems and people that power our community, please
35-
also consider membership in the
36-
[GraphQL Foundation](https://foundation.graphql.org/join).
17+
See more in [CONTRIBUTING.md](CONTRIBUTING.md) about contributing spec changes.
18+
If you want to start a general discussion or concern, please
19+
[open an issue](https://github.com/graphql/composite-schemas-spec/issues).
20+
21+
If you would like to attend a meeting to discuss the spec or an issue, see the
22+
separate
23+
[Composite Schemas Working Group repository](https://github.com/graphql/composite-schemas-wg).
24+
25+
- **Watch the replay of previous meetings:**
26+
[Composite Schemas Working Group Meetings on YouTube](https://www.youtube.com/playlist?list=PLP1igyLx8foFjxyTg6wPn4pUkZwuAk2GR)
3727

3828
---
3929

0 commit comments

Comments
 (0)