Adicionar um código de conduta ao seu projeto

Adote um código de conduta para definir padrões de comunidade, sinalizar um projeto receptivo e inclusivo, bem como descrever procedimentos para tratamento de abuso.

Neste artigo

Um código de conduta define os padrões de como se envolver em uma comunidade. Ele sinaliza um ambiente inclusivo que respeita todas as contribuições. Ele também descreve procedimentos para solucionar problemas entre integrantes da comunidade do projeto. Para obter mais informações sobre por que um código de conduta define padrões e expectativas de como se envolver em uma comunidade, confira o Guia de Código Aberto.

Antes de adotar um código de conduta para seu projeto:

  • Pesquise diferentes códigos de conduta desenvolvidos para projetos de código aberto. Escolha um que reflita os padrões da comunidade.
  • Considere cuidadosamente se você está disposto e apto a aplicá-lo.

Você pode adicionar um código de conduta ao seu projeto usando um modelo ou criando manualmente um código de conduta personalizado. O seu código de conduta estará disponível de qualquer forma, mas o "Código de Conduta" só será marcado como completo no perfil da comunidade do seu repositório se você usar um modelo. Se você usar um código de conduta escrito por outra pessoa ou organização, certifique-se de seguir as diretrizes de atribuição da fonte. Para saber mais sobre perfis da comunidade, confira "Sobre perfis de comunidade para repositórios públicos".

Você pode criar um código de conduta padrão para sua organização ou conta pessoal. Para obter mais informações, confira "Como criar um arquivo padrão de integridade da comunidade".

Adicionar um código de conduta usando um modelo

O GitHub fornece modelos para códigos de conduta comuns de modo a ajudar você a adicionar rapidamente um código de conduta ao seu projeto.

  1. Em GitHub, acesse a página principal do repositório.

  2. Acima da lista de arquivos, selecione o menu suspenso Adicionar arquivo e clique em Criar arquivo.

    Como alternativa, é possível clicar em na exibição em árvore de arquivos à esquerda.

    Captura de tela da página principal de um repositório. Acima da lista de arquivos, um botão, rotulado como "Adicionar arquivo", é destacado em laranja escuro. No modo de exibição de árvore de arquivos do repositório, um botão com o ícone de sinal de adição também é realçado em laranja escuro.

  3. No campo de nome do arquivo, digite CODE_OF_CONDUCT.md.

  4. Selecione Escolher um modelo de código de conduta.

    Captura de tela de um repositório GitHub que mostra um arquivo markdown sendo criado. Um botão à direita, rotulado "Escolher um modelo de código de conduta", está realçado em laranja escuro.

  5. No lado esquerdo da página, selecione um código de conduta a ser visualizado e adicionado ao seu projeto.

  6. No lado direito da página, complete os campos para preencher o código de conduta selecionado com as informações apropriadas.

  7. Clique em Revisar e enviar.

  8. Revise o conteúdo do código de conduta que está na área de texto.

  9. Clique em Fazer commit das alterações...

  10. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, confira "Criar um commit com vários autores".

  11. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para obter mais informações, confira "Como criar uma solicitação de pull".

    Captura de tela de uma solicitação de pull GitHub mostrando um botão de opção para confirmar diretamente no branch principal ou para criar um branch. O novo branch está selecionado.

  12. Clique em Fazer commit de alterações ou em Propor alterações.

Adicionar um código de conduta manualmente

Se o código de conduta que você deseja usar não estiver disponível nos modelos fornecidos, você pode adicionar um código de conduta manualmente.

  1. Em GitHub, acesse a página principal do repositório.

  2. Acima da lista de arquivos, selecione o menu suspenso Adicionar arquivo e clique em Criar arquivo.

    Como alternativa, é possível clicar em na exibição em árvore de arquivos à esquerda.

    Captura de tela da página principal de um repositório. Acima da lista de arquivos, um botão, rotulado como "Adicionar arquivo", é destacado em laranja escuro. No modo de exibição de árvore de arquivos do repositório, um botão com o ícone de sinal de adição também é realçado em laranja escuro.

  3. No campo do nome de arquivo, digite o nome e a extensão do arquivo.

    • Para tornar o código de conduta visível no diretório raiz do repositório, digite CODE_OF_CONDUCT no campo de nome do arquivo.
    • Para tornar o código de conduta visível no diretório docs do repositório, digite docs/CODE_OF_CONDUCT.
    • Para tornar o código de conduta visível no diretório .github do repositório, digite .github/CODE_OF_CONDUCT.

  4. No novo arquivo, adicione seu código de conduta personalizado.

  5. Clique em Fazer commit das alterações...

  6. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, confira "Criar um commit com vários autores".

  7. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para obter mais informações, confira "Como criar uma solicitação de pull".

    Captura de tela de uma solicitação de pull GitHub mostrando um botão de opção para confirmar diretamente no branch principal ou para criar um branch. O novo branch está selecionado.

  8. Clique em Fazer commit de alterações ou em Propor alterações.