Sua ajuda é muito importante para a experiência de documentação da VTEX. Existem várias maneiras de contribuir, dependendo do portal em que você deseja colaborar e do método de sua preferência. Este guia explica como você pode contribuir para melhorar a documentação da VTEX:
Botão de feedback
Disponível em: Help Center e Developer Portal
Você pode enviar seu feedback sobre qualquer página dos portais de documentação clicando em Feedback no canto superior direito de cada portal.

Ao clicar em "Feedback", uma nova janela do navegador será aberta com um formulário. Veja abaixo as informações que você precisa preencher no formulário de feedback:
- Plataforma: selecione um dos seguintes portais para o qual deseja enviar seu feedback: Help Center, Developer Portal, ou VTEX Learning Center.
- URL (opcional): se você deseja enviar feedback sobre uma página específica de um dos portais mencionados anteriormente, adicione a URL exata da página, por exemplo:
https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions. - Tipo de feedback: escolha o tipo de feedback que deseja dar dentre as opções abaixo.
| Tipo de feedback | Descrição |
|---|---|
| Comment | Deixe um comentário sobre a documentação. |
| Question | Descreva suas dúvidas sobre o conteúdo da documentação. |
| Error | Indique informações incorretas no conteúdo da documentação ou se a página não estiver disponível. |
| Improvement | Sugira melhorias de conteúdo. |
- Feedback: descreva seu feedback com base no tipo de feedback que você escolheu.
- Suggestions (optional): faça uma sugestão para corrigir ou melhorar o conteúdo.
- Attachment (optional): se você tiver arquivos complementares para compartilhar, como capturas de tela, imagens e planilhas, adicione-os nesta seção.
- Follow-up: se quiser que a gente entre em contato com você sobre o seu feedback, selecione
Sim. Na página seguinte do formulário, adicione seu nome e email para que possamos entrar em contato com você.
Isso foi útil?
Disponível em: Help Center e Developer Portal
Você pode enviar comentários sobre qualquer página dos portais de documentação respondendo à opção Isso foi útil? (Was this helpful?).

Você pode deixar um comentário sobre a página e explicar por que achou útil ou não. Clique em SEND FEEDBACK para enviar seu feedback.
Sugerir edições (GitHub)
Disponível em: Help Center e Developer Portal
Você pode colaborar em qualquer página dos portais de documentação clicando em Sugerir edições (GitHub) (Suggest edits).

Ao clicar em Sugerir edições (GitHub) (Suggest edits), uma nova janela do navegador será aberta com a página do repositório de documentação. Siga estas etapas:
-
Na página do repositório de documentação, edite o arquivo de documentação que corresponde às suas sugestões.
Certifique-se de dar suas sugestões com base nos princípios das diretrizes de documentação e no código de conduta.
-
Clique em
Commit changes…. -
No modal Propose changes, preencha as seguintes informações:
Nome do campo Descrição Commit message Escreva uma breve descrição do seu commit, por exemplo, Fix typo.Extended description (Optional) Escreva uma descrição com mais detalhes sobre o seu commit. Create a new branch for this commit and start a pull request Dê um nome à sua branch para que você possa abrir um pull request e a equipe possa revisar suas sugestões. -
Depois de preencher o modal, clique em
Propose changes. -
Crie um pull request com suas alterações, seguindo os seguintes passos:

Nome do campo Descrição Add a title Adicione um título para seu pull request, incluindo o tipo de alteração, o nome do arquivo e o que você alterou, por exemplo, Fix (customer-credit-integration-guide.md): Documentation typos.Add a description Verifique os tipos de alteração que estiver propondo: novo conteúdo, melhoria, ajuste ou correção ortográfica e gramatical. Além disso, fique à vontade para incluir mais detalhes na sua descrição para ajudar a equipe a analisá-la. Reviewers Clique em Reviewerse escolha o grupovtexdocs/vtex-education. -
Clique em
Create pull request.
Após criar um pull request, nossa equipe analisará suas alterações o mais rápido possível e entrará em contato com você através dos comentários do pull request.
Pull requests são um processo colaborativo. Suas sugestões são valorizadas, mas a aprovação não é garantida. Esteja aberto a feedback e discussões.