Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

internal: update CONTRIBUTING guide #4304

Merged
merged 5 commits into from
Nov 27, 2024
Merged

internal: update CONTRIBUTING guide #4304

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c2700e2
update CONTRIBUTING to separate between this repo and the spec
yaacovCR Nov 27, 2024
0fc1418
suggest adding PRs with failing tests when reporting bugs
yaacovCR Nov 27, 2024
4a9241c
add more flexibility to review/merge process
yaacovCR Nov 27, 2024
d06623d
suggest using discord to communicate
yaacovCR Nov 27, 2024
8275958
apply review feedback
yaacovCR Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@

We want to make contributing to this project as easy and transparent as
possible. Hopefully this document makes the process for contributing clear and
answers any questions you may have. If not, feel free to open an
[Issue](https://github.com/graphql/graphql-spec/issues/).
answers any questions you may have.

## Issues

We use GitHub issues to track public bugs and requests. Please ensure your bug
description is clear and has sufficient instructions to be able to reproduce the
issue. The best way is to provide a reduced test case on jsFiddle or jsBin.
issue. The best way is to add a failing test to our test suite via a pull request.

## Pull Requests

Expand All @@ -21,8 +20,8 @@ your [pull requests](https://help.github.com/articles/creating-a-pull-request).
Since graphql-js is a reference implementation of the
[GraphQL spec](https://graphql.github.io/graphql-spec/), only changes which comply
with this spec will be considered. If you have a change in mind which requires a
change to the spec, please first open an
[issue](https://github.com/graphql/graphql-spec/issues/) against the spec.
change to the spec, please consider opening instead an
[issue](https://github.com/graphql/graphql-spec/issues/) against the spec and/or attending a [GraphQL Working Group meeting](https://github.com/graphql/graphql-wg) to discuss your proposal. See the [contribution guide for the specification](https://github.com/graphql/graphql-spec/blob/main/CONTRIBUTING.md) for further information. Stage 1 and 2 proposals may be implemented within graphql-js behind a feature flag.

### GraphQL Specification Membership Agreement

Expand Down Expand Up @@ -74,15 +73,16 @@ ensure your pull request matches the style guides, run `npm run prettier`.
- Trailing commas,
- Avd abbr wrds.

## Review Process
## Review and Merge Process

- Pull requests are required to pass all tests and checks before they can be merged.
- Pull requests should be reviewed by _at least two_ members of the [`@graphql/graphql-js-reviewers`](https://github.com/orgs/graphql/teams/graphql-js-reviewers) team before they can be merged; ideally reviewers affiliated with different organizations
- If a reviewer hasn't responded in 48 hours, feel free to ping them `@graphql/graphql-js-reviewers`.
- Ideally, pull requests should be reviewed by _at least two_ members of the [`@graphql/graphql-js-reviewers`](https://github.com/orgs/graphql/teams/graphql-js-reviewers) team before they are merged, preferably from separate organizations. For more complex pull requests, a larger cohort of reviewers is suggested.
- Any reviewer may request that the topic be brought for more in depth discussion at a [GraphQL JS Working Group meeting](https://github.com/graphql/graphql-js-wg/), where decisions will be made by consensus.
- A PR that has been merged without discussion at a GraphQL JS Working Group meeting may be reverted if a more in depth discussion is later requested.

## Merge Process
## Discussion

Once a pull request has been approved by 2 reviewers from [`@graphql/graphql-js-reviewers`](https://github.com/orgs/graphql/teams/graphql-js-reviewers) team, it may be merged by any member of the [`@graphql/graphql-js-reviewers`](https://github.com/orgs/graphql/teams/graphql-js-reviewers-write) team. For more complex pull requests, a larger cohort of reviewers is suggested. Any reviewer may request that the topic be brought for more in depth discussion at GraphQL JS Working Group meeting, where decisions will be made by consensus. A PR that has been merged without discussion at a GraphQL JS Working Group meeting may be reverted if a more in depth discussion is later requested.
Feel free to reach out via the [graphql-js channel](https://discord.com/channels/625400653321076807/862957336082645006) on the [official Discord server](https://discord.graphql.org/) to discuss issues, pull requests, or anything graphql-js related.

## Release on NPM

Expand Down
Loading