Skip to content

Commit f8ec021

Browse files
committed
update readme
1 parent 326e5d9 commit f8ec021

File tree

4 files changed

+23
-41
lines changed

4 files changed

+23
-41
lines changed

README.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,10 @@
1-
# Working Group Template
2-
3-
This repository contains a template for creating working groups under the
4-
GraphQL Foundation. To use this template you should:
5-
6-
- create a new repository from it
7-
- remove this front-matter
8-
- customize the text in this README
9-
- fill out `(NAME)` in [notes/README.md](notes/README.md)
10-
- fill out `wg.config.js` with details about the WG's schedule
11-
- `name` / `repoUrl` - update with the name and URL of your WG
12-
- `videoConferenceDetails`: ask @Benjie to generate a new series of (recorded) Zoom meetings, then update the URL and password (do NOT change the spacing, it will break the markdown)
13-
- `liveNotesUrl`: create a blank Google document with the same title as the
14-
WG, make it publicly editable, copy instructions from the main GraphQL WG
15-
live notes
16-
- `nth`, `weekday`, `time` - when will your WG be? (e.g. 4th Thursday at 10:30am-12am would be `nth: 4, weekday: "Th", time: "10:30-12:00"`)
17-
- generate your first month's agenda `yarn && yarn gen-agenda YYYY MM` (replacing YYYY MM with the meeting's year and month, e.g. `2025 01`)
18-
- let @Benjie know the first meeting is scheduled and ask for the GraphQL Foundation calendar to be updated
19-
- (optional) ask @Benjie or a TSC member to enable agenda auto-merge:
20-
- set up branch protections on `main`, specifically requiring `EasyCLA` to pass (may require a PR to be raised to trigger EasyCLA the first time?)
21-
- uncomment the block at the top of `.github/workflows/wgutils-automerge.yml`
22-
23-
In this README, items that need replacing are ALLCAPS and surrounded by
24-
parenthesis. We've attempted to make as much of the text as possible generic so
25-
that little customization will be needed.
26-
27-
---
28-
29-
# GraphQL (NAME) Working Group
1+
# GraphQL Community Working Group
302

313
This working group is a subcommittee of the
324
[GraphQL Working Group](https://github.com/graphql/graphql-wg) with the
335
following primary purpose:
346

35-
> (MISSION STATEMENT)
7+
Serve as the steward of GraphQL's global narrative and market positioning in the technology ecosystem. We develop and execute strategic initiatives that reinforce GraphQL's value proposition while fostering an engaged, educated, and expanding community.
368

379
Anyone in the public GraphQL community may attend a meeting of this
3810
subcommittee, provided they first sign the

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"private": true,
44
"license": "OWFa-1.0",
55
"scripts": {
6-
"gen-agenda": "wgutils agenda gen"
6+
"gen-agenda": "wgutils agenda gen",
77
"test:spellcheck": "cspell \"**/*.md\"",
88
"format": "prettier --write \"**/*.{md,yml,yaml,json}\"",
99
"format:check": "prettier --check \"**/*.{md,yml,yaml,json}\""

rfcs/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
11
# RFC (request for comments) Working Documents
22

3-
The files found here are collaborative notes exploring various proposals for advancing this subcommittee. Documents included in this directory imply no specific approval or support nor are any proposals required to create a document here.
3+
The files found here are collaborative notes exploring various proposals for
4+
advancing this subcommittee. Documents included in this directory imply no
5+
specific approval or support nor are any proposals required to create a document
6+
here.
47

58
## Disclaimers
69

7-
* Documents included in this directory imply no specific approval or support for inclusion in the GraphQL spec or other GraphQL projects.
8-
* Documents here may be historical or out of date.
9-
* An RFC may be active without being documented here; there is no requirement to add RFCs here.
10+
- Documents included in this directory imply no specific approval or support for
11+
inclusion in the GraphQL spec or other GraphQL projects.
12+
- Documents here may be historical or out of date.
13+
- An RFC may be active without being documented here; there is no requirement to
14+
add RFCs here.
1015

1116
## Contributing
1217

13-
Pull requests are encouraged. New documents and other non-destructive changes may be merged with a low degree of scrutiny and minimal review.
18+
Pull requests are encouraged. New documents and other non-destructive changes
19+
may be merged with a low degree of scrutiny and minimal review.
1420

1521
That said, please follow these suggestions:
1622

17-
* New proposals should be presented in a [working group meeting](../agendas). Submitting a document here is not sufficient or required to introduce a new proposal.
18-
* Favor documents which define a problem and explore a solution space rather than propose a specific change. The intent of documents found here are to help ask and answer questions to build confidence and advance an RFC.
23+
- New proposals should be presented in a [working group meeting](../agendas).
24+
Submitting a document here is not sufficient or required to introduce a new
25+
proposal.
26+
- Favor documents which define a problem and explore a solution space rather
27+
than propose a specific change. The intent of documents found here are to help
28+
ask and answer questions to build confidence and advance an RFC.

wg.config.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
/** @type {import('wgutils').Config} */
44
const config = {
5-
name: "NAME OF WG",
6-
repoUrl: "https://github.com/graphql/...",
5+
name: "Community Working Group",
6+
repoUrl: "https://github.com/graphql/community-wg",
77
videoConferenceDetails: `https://zoom.us/j/...
88
- _Password:_ ...`,
99
liveNotesUrl: "https://docs.google.com/document/d/...",
@@ -16,7 +16,7 @@ const config = {
1616
attendeesTemplate: `\
1717
| Name | GitHub | Organization | Location |
1818
| :--------------- | :------------ | :----------------- | :-------------------- |
19-
`
19+
`,
2020
/*
2121
// Additional configuration (optional):
2222

0 commit comments

Comments
 (0)