Adicionar recursos de suporte ao projeto

Você pode criar um arquivo SUPPORT para permitir que as pessoas conheçam diferentes maneiras de obter ajuda com o seu projeto.

Para direcionar as pessoas para recursos de suporte específicos, adicione um arquivo SUPPORT à raiz do repositório, a docs ou à pasta .github. Quando uma pessoa cria um problema no seu repositório, ela vê um link para o arquivo SUPPORT do projeto.

Captura de tela do formulário de um novo problema. Na barra lateral direita, na seção "Recursos úteis", há um link rotulado "Suporte" com o contorno em laranja escuro.

Você pode criar recursos padrão de suporte para sua organização ou conta pessoal. Para saber mais, confira Como criar um arquivo padrão de integridade da comunidade.

Tip

Para ajudar as pessoas a encontrar suas diretrizes de suporte, vincule o arquivo SUPPORT de outros locais no repositório, como o arquivo LEIAME.

Adicionar recursos de suporte ao projeto

  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.

    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 SUPPORT.md (com todas as letras em maiúsculas).

  4. Na guia Editar novo arquivo, adicione informações sobre como as pessoas podem obter suporte para seu projeto.

  5. Para revisar o arquivo SUPPORT, clique em Visualizar.

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

  7. 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".

  8. Se você tiver mais de um endereço de email associado à sua conta em GitHub, clique no menu suspenso do endereço de email e selecione o email a ser usado como o endereço de email do autor do Git. Apenas endereços de e-mail verificados aparecem neste menu suspenso. Se você habilitou a privacidade do endereço de email, um email sem resposta será o endereço de email do autor de commit padrão. Para obter mais informações sobre a forma exata que o endereço de email sem resposta pode assumir, consulte "Configurar o endereço de e-mail do commit”.

    Captura de tela de uma solicitação de pull do GitHub que mostra um menu suspenso com opções para escolher o endereço de email do autor do commit. octocat@github.com está selecionado.

  9. 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.

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