Thanks for your interest in contributing!
-
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.
- 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").
Use the included pull_request_template.md to tell us more about the changes you propose.
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 |