Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 6.26 KB

contributing.md

File metadata and controls

111 lines (75 loc) · 6.26 KB
source-git-commit workflow-type source-wordcount ht-degree
86d7fba92705b808b45d655a432bb92ed9f9181a
tm+mt
576
1%

Contribuição

Obrigado por colaborar!

A seguir, há um conjunto de orientações que devem ser seguidas ao contribuir para esse projeto.

Código de conduta

Este projeto adere ao código de conduta da Adobe. Ao participar, espera-se que você mantenha esse código. Denuncie comportamento inaceitável para Grp-opensourceoffice@adobe.com.

Documentação do guia do colaborador

Consulte o Guia do Colaborador.

Você tem uma pergunta?

Comece registrando um problema. Os executores existentes neste projeto trabalham para alcançar consenso sobre a direção do projeto e soluções de problemas nos threads de problemas (quando apropriado).

Contrato de licença de colaborador

Todas as contribuições de terceiros a este projeto devem ser acompanhadas por um contribuidor assinado contrato de licença. Dessa forma, a Adobe tem permissão para redistribuir suas contribuições como parte do projeto. Assine nosso CLA. Você é necessário enviar apenas um Adobe CLA por vez. Se já tiver enviado anteriormente, você está pronto para ir!

Revisões de código

Todos os envios devem vir na forma de solicitações de pull e precisam ser revisados pelos responsáveis pelo projeto. Leia a documentação de solicitação de pull do GitHub para obter mais informações sobre envio de pull requests.

Por último, siga o modelo de solicitação de pull quando enviando um pull request!

Do colaborador para o confirmador

Adoramos contribuições vindas de nossa comunidade! Se você quiser ir além como colaborador e se tornar um executor com acesso total à gravação e voz ativa no projeto, você deve para o projeto. Os responsáveis existentes empregam uma indicação interna processo que deve alcançar consenso lento (silêncio é aprovação) antes dos convites são emitidos. Se você se sentir qualificado e quiser se envolver mais, fique à vontade para entrar em contato com os responsáveis existentes e conversar sobre isso.

Problemas de segurança

Problemas de segurança não devem ser relatados neste rastreador de problemas. Em vez disso, envie um problema para nossos especialistas em segurança.

Destaques das novidades

Se as alterações introduzirem novos tópicos, atualizações significativas ou correções que precisam ser destacadas, você poderá adicionar uma breve descrição à seção Novidades diretamente do corpo da solicitação de pull.

Para adicionar um destaque de Novidades:

  1. Inclua a tag whatsnew com a descrição apropriada no corpo da solicitação de pull no final. A descrição deve fornecer contexto sobre a alteração e um link para o(s) tópico(s) de destino. Use o seguinte formato (as aspas de bloco de código são somente para representação e não as inclua no corpo da solicitação de pull):

    whatsnew
Short description of the change in the [target topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/target-topic.html).

    ou, se houver vários tópicos:

    whatsnew
Short description of the changes in the [first target topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/target-topic.html), [second target topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/second-target-topic.html), and [third target topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/third-target-topic.html).

    você também pode usar listas para vários destaques:

    whatsnew
- Short description of the first change in the [first topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/first-topic.html).
- Short description of the second change in the [second topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/second-topic.html).

    whatsnew
The following changes were made to the documentation:
- Short description of the first change in the [first topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/first-topic.html).
- Short description of the second change in the [second topic](https://experienceleague.adobe.com/en/docs/commerce-operations/operational-guides/second-topic.html).

  2. Adicione rótulos compatíveis que indiquem o tipo de alteração. Os rótulos compatíveis incluem rótulos para cada tipo de alteração, como:

    • new-topic - para novos tópicos
    • major-update - para atualizações importantes que podem incluir alterações significativas no conteúdo, estrutura ou funcionalidade
    • technical - para alterações técnicas que não são consideradas atualizações importantes, mas ainda exigem atenção

    e, opcionalmente, rótulos para o escopo da alteração, como:

    • qpt - para alterações relacionadas à Ferramenta de correção de qualidade

Importante:

  1. A parte whatsnew deve começar na tag whatsnew e estar no final do corpo da solicitação de pull.
  2. As descrições das alterações devem incluir os links de trabalho. Certifique-se de que os links estejam corretos e levem aos tópicos pretendidos. Se o tópico for novo, verifique se os links estão funcionando após mesclar a solicitação de pull e publicar o novo tópico. Não há problema em corrigir os links após a mesclagem da solicitação de pull.

Por exemplo, pesquise nas solicitações de pull fechadas no repositório para ver como os realces existentes estão formatados e compare-os com a seção Novidades para ver como eles aparecem na documentação.