Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 4.14 KB
Raw

Contributing to BigCommerce Developer Documentation

Thanks for showing interest in contributing!

The following is a set of guidelines for contributing to BigCommerce's Developer Documentation. These are guidelines, not rules. Use your best judgment, and make proposed changes to this document in a pull request.

Making a Quick Edit

The easiest way to edit a file is using GitHub's web interface:

  1. Navigate to the file in GitHub. For example, store-logs.mdx.

  2. Click the pencil icon to Edit This File.

  3. Make the edit.

  4. Type a commit message.

  5. Select Create a new branch for this commit and start a pull request.

  6. Give the branch a descriptive name.

  7. Click Propose file change.

  8. Give the pull request a descriptive title.

  9. Fill in the pull request description.

  10. Click Create pull request.

That's it! You're done.

Editing Locally

For more complex changes, fork and edit locally:

  1. Fork bigcommerce/docs.

  2. git clone the fork to your local machine.

  3. Make edits on a new branch in your IDE of choice.

  4. Commit and push changes to your remote repo.

  5. Create a pull request to bigcommerce:docs/main.

Commit Messages

  • Always include subject; include body when necessary.
  • Use present tense ("Add feature" not "Added feature").
  • Use imperative mood ("Fix broken link..." not "Fixes broken link...").
  • Separate subject from body with a blank line.
  • Limit the subject line to 50 characters.
  • Capitalize the subject line.
  • Do not end the subject line with a period.
  • Use the body to explain what and why versus how.

Style Guides

Contributing to Other Projects

There are many other public BigCommerce repositories accepting contributions. If you're interested in contributing to those projects, see the full list of public source repos. Also, consider joining the BigCommerce Developer Community.

Contributing to BigCommerce's API Specifications

Thanks for your interest in contributing!

Edit

  • Edit: Fork the repository and edit with your preferred editor. We recommend VS Code.

  • Lint: Check for errors using Spectral or another OAS linter.

  • Commit: Write good commit messages using the guidelines in the following section.

  • Push to your fork to ensure that your pull request contains the most up-to-date version of your code.

Write descriptive commit messages

  • Describe the change using at least one verb and one noun.
  • Use specific nouns to identify what you changed.
  • Use the present tense ("Fix broken link to x" not "Fixed broken link to x").
  • Use the imperative mood ("Fix broken link to x" not "Fixes broken link to x").

Pull request

What is a pull request?

Use the included pull_request_template.md to tell us more about the changes you propose.

Tools

The following tools might be helpful.

Tool Description
Spectral CLI Node.js CLI for the Spectral OpenAPI linter
Spectral Linter for VS Code The Spectral OpenAPI linter as a VS Code extension
swagger2openapi Node.js CLI for converting Swagger to OpenAPI 3.0
openapi.tools List of open-source OpenAPI tools