Skip to content
This repository was archived by the owner on Nov 3, 2019. It is now read-only.

Files

Latest commit

 

History

History
38 lines (26 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.14 KB

Contributing

🙏 Thanks for your interest in contributing!

Setup

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

yarn

This project uses lerna 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.