External contribution guide

Thanks for your interest in contributing to VTEX API Documentation! Here are a few general guidelines on contributing and reporting bugs to VTEX that we ask you to first look at.

Contributing

We encourage everyone to participate in the building of our documentation. We usually focus our PRs on the following topics:

• New content (endpoints, descriptions or fields from scratch)
• Improvement (make an endpoint's title or description even better)
• Spelling and grammar accuracy (self-explanatory)

ℹ️ You should create semantic commits and one PR for each API file to facilitate the technical writer's review.

Style Guidelines

In order to generate VTEX's public API docs we use the OpenAPI v3 format and have created a OpenAPI Template that contains all fields that we consider required for our API documentation. Please check the template before contributing.

Review

You must add the @technical-writers as your contribution's reviewers. By adding the team, we will indicate the right person to review your PR.

Code of Conduct

Please follow our Code of Conduct. Contributions outside the code will be denied.