diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2806972..90358dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,15 @@ Thanks for your interest in contributing! GAPs are community-driven proposals that address issues outside the core GraphQL specifications. +## GAP Number Ranges + +GAPs use number ranges to categorize different types of proposals: + +- **1XXX** — Community directive specifications + +Other ranges may be added in the future as new categories are identified. The +TSC are responsible for creating new GAP ranges. + ## Filing a GAP 1. File an issue outlining the topic for public vetting. @@ -11,8 +20,8 @@ that address issues outside the core GraphQL specifications. author. 3. Find a sponsor with merge rights (this may be one of the authors). 4. Once approved by the authors and sponsor, GAP editors assign the GAP a - number (not necessarily the next available number), configure `CODEOWNERS`, - and merge. + number from the appropriate range (not necessarily the next available + number), configure `CODEOWNERS`, and merge. 5. GAP numbers never change. If a proposal needs significant changes, create a new GAP and deprecate the old one. diff --git a/README.md b/README.md index 1893e3d..dd3c22c 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,14 @@ includes additional navigational assistance and cross-linking: https://gaps.graphql.org/ +## GAP Numbering + +GAPs use number ranges to categorize different types of proposals: + +- **1XXX** — Community directive specifications + +Other ranges may be added in the future as new categories are identified. + ## Repository structure Each proposal lives in its own `GAP-NNNN` folder and must include: