Pull copyright and license into repo-level LICENSE.md #1172
Conversation
leebyron
added
the
✏️ Editorial
✅ Deploy Preview for graphql-spec-draft ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| [GraphQL Specification Project](https://graphql.org/community/) was established | ||
| also in 2019 as the Joint Development Foundation Projects, LLC, GraphQL Series. | ||
|
|
There was a problem hiding this comment.
I would restore this paragraph break.
| [graphql/graphql-spec](https://github.com/graphql/graphql-spec/). Contributions | ||
| are managed by the | ||
| [GraphQL Working Group](https://github.com/graphql/graphql-wg), hosted by the | ||
| [GraphQL TSC](https://github.com/graphql/graphql-wg/blob/main/GraphQL-TSC.md). |
There was a problem hiding this comment.
We shouldn't use an abbreviation the first time the term is introduced:
| [GraphQL TSC](https://github.com/graphql/graphql-wg/blob/main/GraphQL-TSC.md). | |
| [GraphQL Technical Steering Committee](https://github.com/graphql/graphql-wg/blob/main/GraphQL-TSC.md). |
(Feel free to append (TSC) if we want to refer to it again, but I don't think we do.)
| @@ -0,0 +1,64 @@ | |||
| # D. Appendix: Conformance & Licensing | |||
There was a problem hiding this comment.
Does it make sense to have these be in the same appendix? I feel like having an extra focussed appendix is not too costly, and "conformance" and "licensing" feel somewhat separate to me.
|
|
||
| GraphQL has evolved and may continue to evolve in future editions of this | ||
| specification. Previous editions of the GraphQL specification can be found at | ||
| permalinks that match their | ||
| [release tag](https://github.com/graphql/graphql-spec/releases). The latest | ||
| working draft release can be found at | ||
| [https://spec.graphql.org/draft](https://spec.graphql.org/draft). | ||
|
|
There was a problem hiding this comment.
I think we should keep a couple of the main call-outs to the appendices here; especially where reading them up-front may be beneficial to some readers. Perhaps:
| See [Appendix A](#sec-Appendix-Notation-Conventions) for more details about the | |
| definition of algorithms, data collections, and other notational conventions | |
| used in this document. | |
| A conforming implementation of GraphQL must fulfil all normative requirements. | |
| Conformance requirements expressed as algorithms and data collections can be | |
| fulfilled by an implementation of this specification in any way as long as the | |
| perceived result is equivalent. See [Appendix D](#sec-Appendix-Conformance) for | |
| details. |
(Aside: should that "algorithms and data collections" be "algorithms or data collections"?)
Ensures the repo has a top level LICENSE.md file without concern of skew from the spec text by way of an import reference.
This also moves the License and conformance section into an appendix, and does some editorial to the spec introduction including adding links about contribution. Hopefully this makes it easier to read since the ToC is much more likely to be above the fold.