Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.73 KB

File metadata and controls

36 lines (22 loc) · 1.73 KB

Contributing

At Reaction Commerce, we're dedicated to the open source community. In fact, we've designed our entire platform and business to grow from the passion and creativity that an open source community ignites. We've already attracted a small, dedicated team of open source contributors, and there's always room for more.

If you'd like to join us, check out our detailed Contributing Guide.

Contributing to Docs

  1. Click on Edit on GitHub from any Reaction Commerce documentation page.
  2. Click on the 🖊️ to enter edit mode.
  3. Make changes and commit changes with the Create a new branch for this commit and start a pull request. option.
  4. Make a pull request against the master branch.

Linting

Reaction Docs uses remark-lint for linting Markdown style:

Linking

  1. To link from one documentation page to another, always use .md file extension:

[Store Operator Guide](/admin/dashboard.md) Example: Store Operator Guide

  1. To link to a specific point within the same page, use a # anchor tag:

[Testing](#testing) Example: Testing

  1. To link to a specific point in a different page, use both .md and #:

[Variable naming convention](/developer/contributing/styleguide.md#variables) Example: Variable naming convention