Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (18 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 1.06 KB

Contributing to the Beamable Documentation Repository

At present, the state of the docs repo is mutable and in flux. Always check with Vitor Balbio on Slack before deciding where a new page should go.

When making modifications and corrections, check with Balbio about which branch to start from and then follow PR procedures:

  1. Make a new branch starting from the relevant subject-specific branch.
  2. Commit your changes to your new branch
  3. Push your changes and open a PR
  4. Get reviews. Balbio should always be a PR reviewer
  5. When approved, merge your changes (TODO: squash-merge? rebase-merge? merge-merge?)

Style Reference

Primary style references for prose and formatting decisions:

Project-specific rules (heading capitalization, code term formatting, product name capitalization, etc.) are documented in CLAUDE.md on this branch.