Edit This Page

Contribua com o Kubernetes docs

Caso você gostaria de contribuir com a documentação ou o site do Kubernetes, ficamos felizes em ter sua ajuda! Qualquer pessoa pode contribuir, seja você novo no projeto ou se você já esta no mercado há muito tempo. Além disso, Se você se identifica como desenvolvedor, usuário final ou alguém que simplesmente não suporta ver erros de digitação.

Começando

Qualquer pessoa pode abrir uma issue descrevendo o problema ou melhorias desejadas com a documentação ou contribuir com uma alteração e uma solicitação de mudança (Pull Request - PR). Algumas tarefas exigem mais confiança e precisam de mais acesso na organização Kubernetes. Veja Participando do SIG Docs para mais detalhes sobre as funções e permissões.

A documentação do Kubernetes reside em um repositório do GitHub. Nós damos as boas-vindas a todas as contribuições, mas você vai precisa estar familiarizado com o uso básico de git e GitHub para operar efetivamente na comunidade Kubernetes.

Para se envolver com a documentação:

  1. Assine o Contrato de Licença de Colaborador do CNCF.
  2. Familiarize-se com o repositório de documentação e o gerador de site estático hugo.
  3. Certifique-se de entender os processos básicos para melhorar o conteúdo e revisar alterações.

Melhores Práticas recomendadas para contribuições

  • Escreva mensagens GIT claras e significativas.
  • Certifique-se de incluir Github Special Keywords que faz referência a issue e o fecha automaticamente quando o PR é mergeado.
  • Quando você faz uma pequena alteração em um PR, como corrigir um erro de digitação, qualquer alteração de estilo ou gramática, certifique-se de esmagar seus commits (squash) para não obter um grande número de commits por uma alteração relativamente pequena.
  • Certifique-se de incluir uma boa descrição de PR explicando as alterações no código, o motivo de alterar um trecho de código e garantir que haja informações suficientes para o revisor entender seu PR.
  • Leituras adicionais:

Outras maneiras de contribuir

  • Para contribuir com a comunidade Kubernetes por meio de fóruns on-line, como Twitter ou Stack Overflow, ou aprender sobre encontros locais e eventos do Kubernetes, visite o a area de comunidade Kubernetes.
  • Para contribuir com o desenvolvimento de novas funções, leia o cheatsheet do colaborador para começar.

Qual é o próximo