/dev-docs

This repo contains the markdown files and static assets powering developer.bigcommerce.com. https://developer.bigcommerce.com/

Primary LanguageCSS

BigCommerce Developer Documentation

This repo contains the markdown files and static assets powering developer.bigcommerce.com, which includes:

Directory Structure

./

.
├── archive                            # Deprecated content
├── assets                             # Static files
├── docs                               # Repo documentation
├── markdown                           # Markdown source code for articles
├── samples                            # sample app code
└── spec                               # API spec files

./markdown/

.
├── ...
├── markdown                           
│    ├── api-docs                      # Server-to-Server and Storefront API docs
│    ├── bigcommerce-for-wordpress     # BigCommerce for Wordpress docs
│    ├── legacy                        # Legacy Blueprint and V2 API docs
│    ├── stencil-docs                  # Theme docs
├── ...

./assets/

.
├── ...
├── assets                             
│    ├── css                           # devcenter css
│    ├── fonts                         # devcenter fonts
│    ├── icons                         # devcenter icons
│    ├── img                           # screenshots, etc
│    ├── js                            # devcenter js 
├── ...

Contributing to BigCommerce Developer Documentation

This document contains guidelines for contributing to BigCommerce Developer Documentation. These are guidelines, not rules; as such, use your best judgment, and feel free to propose changes to this document with a pull request.

Thanks for showing interest in contributing!

Common Issues

  1. mending spelling and grammar mistakes
  2. fixing broken links
  3. clarifying confusing passages
  4. simplifying complex instructions

Git Commit Messages

  • Always include subject; include body when necessary
  • Use the present tense ("Add feature" not "Added feature")
  • Use the 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 vs. how

Making Pull Requests

  • It must include a JIRA ticket number
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • PLEASE DO NOT MERGE PULL REQUESTS. You are able to approve them, let a member of the dev docs term merge the request.

Contributing to other BigCommerce Projects

If you would like to open an issue for anything besides the API or the documentation, here are our other public repositories. You an also join our BigCommerce Developers group for specific questions on working with the API and platform questions.