Thanks for showing interest in contributing!
Clone the respoitory and edit with your preferred editor (we recommend VS Code or Stoplight Studio).
Check for errors using Spectral.
Commit your changes.
- Always include subject.
- Capitalize the subject.
- Use present tense ("Add Feature" not "Added Feature").
- Use imperative mood ("Fix Broken Link" not "Fixes Broken Link").
Open a pull request; explain your changes in the description.
Below are some tools we find useful.
| Tool | Description |
|---|---|
| BigCommerce Stoplight Workspace | BigCommerce' Stoplight Platform instance |
| Spectral CLI | Node.js command-line interface for Stoplight's OpenAPI linter |
| Spectral Linter for VS Code | Stoplight's OpenAPI linter as a VS Code extension |
| swagger2openapi | Node.js command-line tool for converting Swagger to OpenAPI 3.0 |
| openapi.tools | Open source list of OpenAPI tools |