Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.74 KB
Raw

Contributing to the BigCommerce Python API Client

Thanks for showing interest in contributing!

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

By contributing to the BigCommerce Python API client, you agree that your contributions will be licensed under its MIT license.

Table of Contents

API Documentation

How Can I Contribute?

Styleguides

Your First Code Contribution

Unsure where to begin contributing to the API client? Check our forums, our stackoverflow tag, and the reported issues.

Pull Requests

  • Fill in the required template
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • End files with a newline.

Styleguides

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

Python Styleguide

All Python must adhere to PEP8 Python Code Styleguide.