Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 3.09 KB
Raw

Contributing to Commerce.js SDK Documentation

At Chec/Commerce.js, we believe open source developer tools documentation is a collaborative effort to be continuously improved on. We welcome and encourage all contributions to the Commerce.js documentation from the community, be it small or big. Contributing to the documentation source will require basic knowledge of Markdown formatting and styling.

The SDK documentation module source code resides in commerce.js/docs. The docs source is fetched and added to a root directory in the Commerce.js website.

What can you contribute?

  • Errors, typos, or any other improvements to current documentation
  • A full-page new documentation to highlight a feature or resource

Here are some basic guidelines to start making contributions to the SDK documentation:

Get Help

Do reach out on Slack or Twitter and we are happy to help.

  1. Drop by the Slack channel.
  2. Say hi on Twitter.

Edit online

The simplest way to edit the documentation is to do it on GitHub's interface. All documentation source is located in commerce.js/docs, so all you'll need to do is locate the appropriate .md file in chec/commerce.js/docs and edit.

  1. Navigate to the file in GitHub in chec/commerce.js/docs
  2. Click the pencil icon in the top right corner and it will switch the document to an edit mode
  3. Type a commit message and any necessary description after making your edit
  4. Select Create a new branch for this commit and start a pull request
  5. Give your branch name a prefix and a description. See here.
  6. Click Propose file change
  7. Give the pull request a descriptive title similar to your branch name and a description
  8. Click Create pull request to submit

Edit locally

For more complex changes, you'll want to fork the repo and edit locally:

  1. Fork chec/commerce.js
  2. git clone the fork to your local machine
  3. Make edits in your favorite code editor on a new branch
  4. Commit and push changes to your remote repo
  5. Create a pull request to chec/commerce.js/master

Commit messages and branch name

  • Commit messages should be in the imperative tense ie. Edit the intro section of cart vs. Edited the intro section of cart
  • Your branch should be prefixed with either Feature for new documentation content or Bugfix for typos and other small changes. Ie. Feature/new-cart-content

Contributing to other Chec open source projects

To contribute to other Chec open source projects, see a full list here.