Adicionando uma página de acessibilidade ao repositório

Quando um repositório contém um ACCESSIBILITY.md arquivo, GitHub exibe uma guia Acessibilidade na visão geral do repositório e links para a página da seção Sobre do repositório.

GitHub procura o arquivo no .github diretório, a raiz do repositório e o docs diretório nessa ordem. Se o repositório não contiver uma página de acessibilidade, ele poderá herdar um de um repositório chamado .github que pertence à organização.

Uma página de acessibilidade pode descrever as prioridades de acessibilidade do projeto, ambientes com suporte, barreiras conhecidas, expectativas de colaborador, processo de relatório, propriedade e manutenção.

Adicionando uma página de acessibilidade do Community Standards

Para um repositório público, você pode começar com o modelo de página de acessibilidade.

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

2. No nome do repositório, clique em Insights.

   

3. Na barra lateral esquerda, clique em Padrões da Comunidade.

4. Em "Arquivo de comunidade adicional", localize "Acessibilidade" e clique em Adicionar ou Propor.

5. Substitua as instruções no modelo por informações relacionadas à acessibilidade do seu projeto. As instruções são armazenadas em comentários e não aparecem quando GitHub renderiza o arquivo.

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

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

   

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

Criando uma página de acessibilidade manualmente

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 ACCESSIBILITY.md. Para armazenar o arquivo no diretório ou docs no .github diretório, digite .github/ACCESSIBILITY.md ou docs/ACCESSIBILITY.md.

4. Na guia Editar novo arquivo , adicione informações relacionadas à acessibilidade.

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. Se você tiver mais de um endereço de e-mail associado à sua conta no GitHub, clique no menu suspenso de endereço de e-mail e selecione o endereço de e-mail a ser usado como endereço de e-mail do autor no 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, confira Configurar o endereço de e-mail do commit.

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

   

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