Thanks for showing interest in contributing!
- Edit: Fork the repository and edit with your preferred editor (we recommend VS Code or Stoplight Studio).
- Lint: Check for errors using Spectral.
- 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.
- 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").
Internal users: Consult the repo's internal_pr_template to learn more about our pull request process. Then use the template to create your PR's description.
External users: Consult the repo's external_pr_template to learn more about our pull request process. Then use the template to create your PR's description.
The following tools might be helpful.
| Tool | Description |
|---|---|
| BigCommerce Stoplight Workspace | Our hosted documentation back end. Contains editing tools for internal users. |
| Spectral CLI | Node.js CLI for Stoplight's OpenAPI linter |
| Spectral Linter for VS Code | Stoplight's 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 |