Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 1.68 KB

Contributing to BigCommerce App SDK

Thanks for showing interest in contributing!

The following is a set of guidelines for contributing to the BigCommerce App SDK. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

API Documentation

How Can I Contribute?

Styleguides

Pull Requests

First ensure that your feature isn't already being developed or considered (see open PRs and issues). If it is, please consider contributing to those initiatives.

All PRs require test coverage to be accepted when applicable.

Issues / Bugs

  • Please include a clear, specific title and replicable description.

  • Please include your environment, OS, and any exceptions/backtraces that occur. The more information that is given, the more likely we can debug and fix the issue.

If you find a security bug, please do not post as an issue. Send directly to [email protected] instead.

Other Ways to Contribute

  • Consider contributing to app-sdk-js documentation on the wiki, reporting bugs, contributing to test coverage, or helping spread the word about app-sdk-js.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference pull requests and external links liberally

Thank you again for your interest in contributing to app-sdk-js!