Skip to content

Commit c082720

Browse files
committed
DRAFT.md should be in spec-md format
1 parent 7077f46 commit c082720

3 files changed

Lines changed: 40 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ that address issues outside the core GraphQL specifications.
2020

2121
Each `GAP-NNNN` folder must include:
2222

23-
- `DRAFT.md` — the working document of the proposal/specification
23+
- `DRAFT.md` — the working document of the proposal/specification, written in
24+
[`spec-md`](https://spec-md.com/) format
2425
- `README.md` — a brief overview, why it exists, current status, challenges,
25-
drawbacks, and related resources/prior art
26+
drawbacks, and related resources/prior art (written in GitHub Flavoured
27+
Markdown)
2628
- `metadata.yml` — maintainers, status, and related metadata
2729

2830
#### `metadata.yml`

package-lock.json

Lines changed: 26 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
{
22
"name": "@graphql/gaps",
33
"private": true,
4+
"homepage": "https://gaps.graphql.org/",
45
"scripts": {
5-
"format": "prettier --write ."
6+
"format": "prettier --write .",
7+
"suggest:format": "echo \"\nTo resolve this, run: $(tput bold)npm run format$(tput sgr0)\" && exit 1",
8+
"test:format": "prettier --check . || npm run suggest:format",
9+
"test:spelling": "cspell \"spec/**/*.md\" README.md LICENSE.md"
610
},
7-
"dependencies": {
8-
"prettier": "^3.8.1"
11+
"devDependencies": {
12+
"cspell": "5.9.1",
13+
"nodemon": "2.0.20",
14+
"prettier": "^3.8.1",
15+
"spec-md": "^3.1.0"
916
}
1017
}

0 commit comments

Comments
 (0)