Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 1.41 KB
Raw

Contributing

All contributions are welcome and greatly appreciated!

Steps to Contribute

Warning

Check the engine property in package.json to see what version of Node.js is required for local development. This can be different from the version of Node.js used on the GitHub Actions runners. Tools like nodenv can be used to manage your Node.js version automatically.

  1. Fork this repository
  2. Work on your changes
  3. Preview your changes (npm run develop)
  4. Open a pull request back to this repository
  5. Notify the maintainers of this repository for peer review and approval
  6. Merge 🎉

The maintainers of this repository will review your changes and provide any feedback. Once approved, they will be merged in and a new version of the site will be deployed. You'll also be able to see your GitHub profile tagged in the contributors list for any pages you contribute to!

Theme

This repository uses Gatsby, along with the following themes and components:

A modified version of the Doctocat theme is used to build the documentation from .mdx files in the docs directory. Make sure to check out the above links to get familiarized with Gatsby, Primer, and React 😄