Skip to content
This repository has been archived by the owner on Dec 19, 2019. It is now read-only.

Home

Jump to bottom
Oleksii Korshenko edited this page Oct 27, 2019 · 24 revisions

Overview

Welcome to the Magento 2 GraphQL Community Project!

Here is our ZenHub Task Board. If not using ZenHub, our backlog is organized as a list of issues in GitHub.

GraphQL is a flexible and performant API for building Magento-based custom front-ends, including headless storefronts, PWAs, and mobile apps. To learn more about GraphQL, please visit graphql.org. To get a head start on the GraphQL implementation in Magento, our DevDocs are here.

Roadmap

For details on current status and roadmap, please see Magento GraphQL Roadmap.

Contribution

To join the project, attend a weekly meeting or join #graphql slack channel (Use http://opensource.magento.com/slack to register)

Weekly Meetings: Every Thursday at 16:00 UTC, https://bluejeans.com/7850571097

Weekly Meeting Recordings: https://goo.gl/5Q7QAw

Approach to Implementation

See Approach to Implementation for the requirements and restrictions of the implementation process.

Issues Board

See Issues Board on Backlog project for the list of issues.

Pipelines:

  • New - newly created items, which have not been discussed or triaged yet
  • For Grooming - candidates for backlog items that require further team discussion. Do not take items from this pipeline
  • Ready to Start - issues ready to be picked up. Please filter the board by nearest Milestone (usually the next patch release) for the most relevant/prioritized work.
  • Investigation - being investigated by someone to clarify requirements or implementation details
  • In Progress - in progress by someone
  • Review/QA - in review or QA by Magento team
  • Merging in Progress - the PR is in being processed by Magento team to be merged to target branch. ❕ The pipeline may also contain items that wait for a related PR in another repository (can be an internal repository and so not visible for community)
  • Closed - closed issues

Feel free to add an issue to the list of issues if you know of any. These will be reviewed by the core team to confirm before being taken to work.

Labels

  • good first issue - a good candidate for new contributors to the project
  • backward-incompatible - the fix/implementation might be backward incompatible and needs to be planned for an appropriate release (typically minor release like 2.4, 2.5, etc)
  • blocker - the issue blocks resolution of other issue(s). For example, the issue causes a fatal error, which terminates execution of the application and so blocks validation/fixing of other scenarios
  • investigation-needed - an investigation is needed. A clear solution is not known yet, the issue can't be taken into development
  • additional-coverage - issues which focus on coverage of some functionality with GraphQL API
  • framework-changes - issues which assume modifications to the GraphQL framework
  • requires-ee-changes - requires changes in Magento EE being merged together with the CE fix. Example: update of composer.json in CE requires same changes being applied to composer.json in Magento EE
  • requires-b2b-changes - requires changes in Magento B2B being merged together with the CE fix. Example: update of composer.json in CE requires same changes being applied to composer.json in Magento B2B

Git Repository

There are the following branches in the repository:

Development Environment

You can set up Magento locally, use docker or virtual machine. For those who are just starting, take a look at vagrant box for Magento 2 developers

Documentation

All completed GraphQL features are documented on the dev docs

Useful links

Clone this wiki locally