Skip to content

Latest commit

 

History

History
62 lines (52 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

62 lines (52 loc) · 2.75 KB

Contributing to Garden

Keen to contribute to Garden? We're stoked to have you join us. You may find that opening an issue is the best way to get a conversation started. When you're ready to submit a pull request, follow the steps below. We follow a code of conduct as our guide for community behavior.

Environment Variables

Garden uses the Figma API to source versioned content and images throughout the site. To build this solution generate an Figma API token and add it to your environment under the FIGMA_TOKEN name.

Development Workflow

Before you start, be sure npm is installed on your system. After you clone this repo, run npm install to install dependencies needed for development. After installation, the following commands are available:

  • npm start to launch the Gatsby server with live reload – source files will be watched for changes.
  • npm test to run package tests.
  • npm run lint to enforce consistent code conventions. Note this is run as a git pre-commit hook.
  • npm run format to enforce code style with opinionated formats. Note this is run as a git pre-commit hook.
  • npm run build to rebuild the Gatsby site JS, CSS, and HTML. The build runs as part of the initial install.
  • npm run upgrade to upgrade Garden component packages and sync the react-components submodule.

Pull Request Workflow

  1. Fork the repo and create a branch. Format your branch name as username/verb-noun.
  2. If you haven't yet, get comfortable with the development environment.
  3. Regularly git commit locally and git push to the remote branch. Use whatever casual commit messaging you find suitable. We'll help you apply an appropriate squashed conventional commit message when it's time to merge to the main branch.
  4. When your branch is ready, open a new pull request via GitHub. The repo PR template will guide you toward describing your contribution in a format that is ultimately suitable for a structured conventional commit.
  5. Every PR must pass CI checks and receive at least one 👍 to be considered for merge.
  6. Garden maintainers will manage the squashed merge to the main branch, using your PR title and description as the scope, description, and body for a conventional commit.

License

By contributing to Garden, you agree that your contributions will be licensed under the Apache License, Version 2.0.