🙏 Thanks for your interest in contributing!

Setup

After cloning the repo, run the following command to install dependencies:

yarn

This project uses yarn workspaces to manage multiple packages within one repository. Check out the workspaces key within package.json to view all possible workspace directories. Some workspaces of note:

  • packages/gatsby-mdx: the source for the gatsby-mdx plugin
  • examples/docs: the gatsby-mdx docs site (built with Gatsby)

Submitting a bug report

To submit a bug report, follow this link, which will prepopulate a new GitHub issue with the bug report template.

Submitting a feature request

To submit a feature request, follow this link, which will prepopulate a new GitHub issue with the feature request template.

Writing Tests

If you write tests, write them colocated with the file they're testing using the filename.test.js convention.

edit this page on GitHub