Adicionar um código de conduta ao seu projeto

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 projetados para projetos 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. Seu código de conduta estará disponível de qualquer maneira. No perfil da comunidade de um repositório público, "Código de conduta" será marcado como adicionado se o arquivo não estiver vazio e não indicar que o projeto não tem código de conduta. 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, a menos que você esteja conectado com um conta de usuário gerenciada, para sua conta pessoal. Para saber mais, confira Como criar um arquivo padrão de integridade da comunidade.

Adicionar um código de conduta usando um modelo

GitHub fornece modelos para códigos comuns de conduta para ajudá-lo a adicionar rapidamente um código de conduta ao seu projeto. Para usar um modelo, você deve ter acesso de gravação ao repositório.

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

2. Acima da lista de arquivos, selecione o menu suspenso Add file e clique em Create new file.

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

   

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

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

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

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

3. Clique em Revisar e enviar.

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

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 do commit. Para saber mais, confira Criar um commit com vários autores ou em nome de uma organização.

7. Abaixo dos campos da mensagem de commit, decida se deseja adicionar seu commit ao ramo atual ou a um novo ramo. 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 saber mais, confira Como criar uma solicitação de pull.

   

8. 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ê poderá adicionar manualmente um código de conduta.

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

2. Acima da lista de arquivos, selecione o menu suspenso Add file e clique em Create new file.

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

   

3. No campo nome do arquivo, digite o caminho e o nome do arquivo. GitHub procura um código de conduta no .github diretório, depois a raiz do repositório e, em seguida, o docs diretório e usa o primeiro arquivo encontrado.

   • Para adicionar seu código de conduta ao diretório do .github repositório, digite .github/CODE_OF_CONDUCT.md.
   • Para adicionar o código de conduta ao diretório raiz do repositório, digite CODE_OF_CONDUCT.md.
   • Para adicionar seu código de conduta ao diretório do docs repositório, digite docs/CODE_OF_CONDUCT.md.

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 do commit. Para saber mais, confira Criar um commit com vários autores ou em nome de uma organização.

7. Abaixo dos campos da mensagem de commit, decida se deseja adicionar seu commit ao ramo atual ou a um novo ramo. 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 saber mais, confira Como criar uma solicitação de pull.

   

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