Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 954 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (11 loc) · 954 Bytes

Contributing

Thanks for your interest in contributing! We welcome help in two areas.

Improve the docs

Doc improvements are a great way to get started—typos, broken links, clearer explanations, new examples.

  1. Use Edit this page on any doc (at the bottom of each page on docs.compasscalendar.com)
  2. Open a PR to this repository (compass-docs)
  3. Run the doc site locally to verify: yarn then yarn start

Doc PRs don't need full Compass app setup. Just ensure the site builds and renders (yarn build).

Full details: How to Contribute - Improve the Docs

Contribute to the Compass app

For code, features, and bug fixes to the Compass application itself, see the contribute section in our docs. You'll find workflows, coding conventions, and how to find good first issues.