DOCSEARCHbyAlgolia
Submit Docs

GraphQL Handbooks

website·Indexed 19 days ago

https://handbooks.graphql.org/

Community governance and operational guides for the GraphQL ecosystem. Includes documentation on the Technical Steering Committee (TSC), the GraphQL Local Initiative, the Ambassador Program, Working Group participation, and the GraphQL Foundation grants and crowdfund programs.

Tokens
11.3K
Snippets
17
Records
106
Agent score
96%

What's inside GraphQL Handbooks

  1. Understand the GraphQL Ambassador Program goals

    The GraphQL Ambassador Program aims to increase the adoption of GraphQL through several key strategies: brand advocacy by developers, providing social proof via high-visibility community leaders, increasing the volume of GraphQL content, building a welcoming community of 'known faces', and gathering community feedback on GraphQL initiatives and Specification RFCs.

  2. Understand the purpose and governance of GraphQL Working Groups

    GraphQL Working Groups (WGs) are collaborative bodies consisting of maintainers, implementers, and community experts dedicated to advancing the GraphQL specification and ecosystem. Their primary goals are to advance the spec (reviewing RFCs and roadmaps), coordinate tooling behavior and test suites, surface production feedback, and build the contributor community.

    Governance is provided by the Technical Steering Committee (TSC). All agendas, notes, and recordings are published publicly in the respective working group's GitHub repository. While decisions are based on consensus, unresolved proposals may be escalated to the TSC.

  3. Understand the GraphQL CVE reporting and management process

    Common Vulnerabilities and Exposures (CVEs) are organized by the Mitre Corporation. Anyone can file a CVE report via the Mitre CVE form. A CVE Numbering Authority (CNA) then reviews the report and creates the official record.

    Because external CNAs may lack specific project knowledge, they may occasionally create records that inaccurately reflect a vulnerability. To mitigate this, some open-source projects (such as curl and GraphQL Java) become their own CNAs to manage and validate CVEs affecting their own software.

    Once a CVE is published, security vendors (e.g., Snyk) create records that trigger automated alerts in enterprise environments, forcing users to update to a patched version. While CVEs can be amended after creation, it is recommended to file the CVE only when a bug fix release is already available to minimize disruption.

  4. Requirements to become a GraphQL Ambassador

    To serve as a GraphQL Ambassador, individuals must meet the following criteria:

    • Be knowledgeable about GraphQL and able to articulate concepts clearly.
    • Act as a model community member by adhering to the Standards of Excellence, remaining respectful, constructive, and fair, even when critical of GraphQL or defending it.
    • Maintain neutrality by not promoting other products, services, or personal agendas while acting as an Ambassador.
    • Consent to have their name, face, social media links, and relevant information displayed on the official Ambassadors webpage.
    • Actively participate in one or more of the designated Ambassador tasks.

  5. Understand the roles of the GraphQL TSC and GraphQL Foundation

    The GraphQL organization is split into two primary governing bodies: the Technical Steering Committee (TSC) oversees all technical work, including specifications, working groups, and reference implementations. The GraphQL Foundation manages non-technical operations, including legal matters, budget, events, and marketing.

  6. GraphQL Ambassador Program Benefits and Support

    The GraphQL Foundation provides a support system for Ambassadors to empower them as community leaders and gather feedback on the GraphQL project. Support includes:

    • Direct Access & Feedback: Quarterly online meetings with Foundation and Technical Steering Committee (TSC) representatives featuring project updates, Specification edits, and Q&A sessions for technical or community feedback.
    • Professional Recognition: Public website profiles, biographies/interviews, and Credly badges for social media.
    • Community Networking: A dedicated Ambassador role on the community Discord, including access to a private channel for networking with Foundation and TSC representatives.
    • Content & Visibility: Promotion of Ambassador-created content and conference talk videos.
    • Perks & Funding: Exclusive GraphQL swag (e.g., hoodies), free tickets to the GraphQL Foundation Conference, and the ability to apply for travel funding for approved conference and meetup talks (evaluated case-by-case).
    • Financial Support: Honorariums may be available for specific content creation tasks on a case-by-case basis.

  8. Facilitate a GraphQL Working Group meeting

    Follow these steps during a GraphQL Working Group meeting to ensure inclusivity and efficiency:

    1. Start: Wait for all listed attendees or until 5 minutes past the start time.
    2. Introduction: Welcome the group and state that all participants must agree to the specification membership agreement, participation guidelines, contribution guide, and code of conduct. Mention that meetings are recorded for YouTube and summarized via AI.
    3. Introductions: Invite attendees to give a brief introduction (name and company) for correct pronunciation.
    4. CLA Verification: Ensure all attendees are on the agenda. Unlisted attendees who have not signed the CLA must not participate until they have done so.
    5. Live Notes: Remind attendees of the 'live notes' document and solicit volunteers to update it.
    6. Agenda Review: Review the agenda and allow attendees to add items.
    7. Moderation:
      • Monitor Zoom's 'raise hand' feature and chat to invite reserved participants to speak.
      • If a topic runs over time or becomes cyclic, interrupt and move to the next item, deferring the topic to the next meeting or the end of the current session.
      • Explicitly call out and manually record action items in the live notes (do not rely on AI for this).

  9. Understand GraphQL TSC membership and election rules

    TSC members serve 2-year terms, with half of the committee up for re-election annually. Members are self-nominated; existing members are not automatically included in elections and must reapply to extend their term. There is no limit on the number of consecutive terms a member may serve. While there are no technical limits on the number of members employed by a single workplace, a diverse range of interests and opinions is encouraged during the voting process.

  10. Contribute to the GraphQL specification via Working Groups

    GraphQL Working Groups are the primary mechanism for making advancements to the GraphQL specification and other GraphQL Foundation projects.

  12. Prepare a proposal for the GraphQL Community Grant

    When preparing a grant proposal, follow these guidelines to increase the likelihood of approval:

    • Seek Guidance: Reach out to working group members, the Technical Steering Committee (TSC), or the community gardener (@Benjie) via the #wg channel on the GraphQL Discord.
    • Provide Detail: Ensure the proposal is clear and comprehensive. Since the application description is limited, link to a Google Doc for long-form content or diagrams.
    • Avoid AI Generation: Do not use AI/LLMs to generate the submission; proposals that appear AI-generated may be declined. AI should only be used for minimal refinement.
    • Highlight Experience: Include evidence of contributions to the GraphQL ecosystem, such as PRs, working group attendance, conference talks, or community support on Discord/GitHub.