|
| 1 | +--- |
| 2 | +title: Contribuindo com o Site e Documentação do Selenium |
| 3 | +disableToc: true |
| 4 | +--- |
| 5 | + |
| 6 | +Selenium é um grande projeto de software, seu site e documentação são fundamentais |
| 7 | +para entender como as coisas funcionam e aprender maneiras eficazes de explorar |
| 8 | +seu potencial. |
| 9 | + |
| 10 | +Este projeto contém o site e a documentação do Selenium. Isto é |
| 11 | +um esforço contínuo (não direcionado a nenhuma versão específica) para fornecer |
| 12 | +informações atualizadas sobre como usar o Selenium de forma eficaz, como se |
| 13 | +envolver e como contribuir para o Selenium. |
| 14 | + |
| 15 | +As contribuições para o site e documentação seguem o processo descrito na seção abaixo sobre contribuições. Você deveria passar algum tempo |
| 16 | +familiarizando-se com a documentação lendo |
| 17 | +[mais sobre isso]({{<ref "/introduction/about_this_documentation.pt-br.md">}}). |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +O projeto Selenium recebe contribuições de todos. Há um |
| 22 | +várias maneiras de ajudar: |
| 23 | + |
| 24 | +## Reportar um problema |
| 25 | + |
| 26 | +Ao relatar um novo problema ou comentar sobre problemas existentes, por favor |
| 27 | +certifique-se de que as discussões estão relacionadas a questões técnicas concretas sobre o |
| 28 | +software Selenium, seu site e/ou documentação. |
| 29 | + |
| 30 | +Todos os componentes do Selenium mudam bastante rápido ao longo do tempo, então este |
| 31 | +pode fazer com que a documentação fique desatualizada. Se você observar que este é |
| 32 | +o caso, como mencionado, não hesite em criar um problema para isso. |
| 33 | +Também pode ser possível que você saiba como atualizar a |
| 34 | +documentação, então, envie-nos um Pull Request com a |
| 35 | +alteração. |
| 36 | + |
| 37 | +Se você não tem certeza se o que encontrou é um problema ou não, |
| 38 | +pergunte através dos canais de comunicação descritos em |
| 39 | +https://selenium.dev/support. |
| 40 | + |
| 41 | +## Contribuições |
| 42 | + |
| 43 | +O projeto Selenium dá as boas-vindas a novos contribuidores. Indivíduos fazendo |
| 44 | +contribuições significativas e valiosas ao longo do tempo são transformados em _Committers_ |
| 45 | +e recebem acesso de commit ao projeto. |
| 46 | + |
| 47 | +Este guia irá guiá-lo através do processo de contribuição. |
| 48 | + |
| 49 | +### Passo 1: Fork |
| 50 | + |
| 51 | +Faça um fork do projeto [no Github](https://github.com/seleniumhq/seleniumhq.github.io) |
| 52 | +e faça checkout na sua cópia localmente. |
| 53 | + |
| 54 | +```shell |
| 55 | +% git clone [email protected]:seleniumhq/seleniumhq.github.io.git |
| 56 | +% cd seleniumhq.github.io |
| 57 | +``` |
| 58 | + |
| 59 | +#### Dependências: Hugo |
| 60 | + |
| 61 | +Usamos [Hugo](https://gohugo.io/) para construir e renderizar o site e documentação. |
| 62 | +Para verificar tudo localmente antes mesmo de fazer qualquer alteração, por favor |
| 63 | +[instale Hugo](https://gohugo.io/getting-started/installing/), familiarize-se |
| 64 | +com ele e [execute o servidor local](https://gohugo.io/getting-started/usage/#livereload) |
| 65 | +para renderizar o site localmente (instruções detalhadas podem ser encontradas no |
| 66 | +próximos passos). |
| 67 | + |
| 68 | +### Passo 2: Branch |
| 69 | + |
| 70 | +Crie uma branch e comece a hackear: |
| 71 | + |
| 72 | +```shell |
| 73 | +% git checkout -b my-feature-branch |
| 74 | +``` |
| 75 | + |
| 76 | +Praticamos o desenvolvimento baseado em HEAD, o que significa que todas as mudanças são aplicadas |
| 77 | +diretamente no topo do `trunk`. |
| 78 | + |
| 79 | +### Passo 3: Faça mudanças |
| 80 | + |
| 81 | +O repositório contém o site e documentação, que são dois projetos Hugo separados. Se você quiser fazer alterações no site, trabalhe no |
| 82 | +diretório `site_source_files`. Para ver uma prévia ao vivo de suas alterações, |
| 83 | +execute `hugo server` no diretório raiz do site. |
| 84 | + |
| 85 | +```shell |
| 86 | +% cd site_source_files |
| 87 | +% hugo server |
| 88 | +``` |
| 89 | + |
| 90 | +Para fazer alterações na documentação, vá para o diretório `docs_source_files`. |
| 91 | + |
| 92 | +```shell |
| 93 | +% cd docs_source_files |
| 94 | +% hugo server |
| 95 | +``` |
| 96 | + |
| 97 | +A documentação é traduzida para vários idiomas e as traduções são baseadas no conteúdo em inglês. Ao alterar um arquivo, **certifique-se** de realizar a |
| 98 | +mudanças em todos os outros arquivos traduzidos também. Isso pode ser diferente dependendo |
| 99 | +sobre a mudança, por exemplo: |
| 100 | + |
| 101 | +* Se você adicionar um exemplo de código ao arquivo `browser_manipulation.en.md`, |
| 102 | +também adicione-o a `browser_manipulation.es.md`,` browser_manipulation.ef.md`, |
| 103 | +`browser_manipulation.ja.md`, e todos os outros arquivos traduzidos. |
| 104 | +* Se você encontrar uma tradução que possa ser melhorada, altere apenas o arquivo traduzido. |
| 105 | +* Se você estiver adicionando uma nova tradução de idioma, adicione os novos arquivos com o |
| 106 | +sufixo apropriado. Não há necessidade de traduzir tudo para enviar um |
| 107 | +PR, pode ser feito iterativamente. Não se esqueça de verificar algumas configurações necessárias de |
| 108 | +valores no arquivo `config.toml`. |
| 109 | +* Se você fizer alterações de texto na versão em inglês, substitua a mesma seção em |
| 110 | +os arquivos traduzidos com sua alteração (sim, em inglês), e adicione o seguinte |
| 111 | +observe na parte superior do arquivo. |
| 112 | + |
| 113 | + |
| 114 | +``` |
| 115 | +{{%/* notice info */%}} |
| 116 | +<i class="fas fa-language"></i> Page being translated from |
| 117 | +English to {LANGUAGE}. Do you speak {LANGUAGE}? Help us to translate |
| 118 | +it by sending us pull requests! |
| 119 | +{{%/* /notice */%}} |
| 120 | +``` |
| 121 | + |
| 122 | +### Passo 4: Commit |
| 123 | + |
| 124 | +Primeiro, certifique-se de que o git saiba seu nome e endereço de e-mail: |
| 125 | + |
| 126 | +```shell |
| 127 | +% git config --global user.name 'Santa Claus' |
| 128 | +% git config --global user.email '[email protected]' |
| 129 | +``` |
| 130 | + |
| 131 | +**Escrever boas mensagens de commit é importante.** Uma mensagem de confirmação |
| 132 | +deve descrever o que mudou, por que e conter referência de problemas corrigidos (se |
| 133 | +houver). Siga estas diretrizes ao escrever um: |
| 134 | + |
| 135 | +1. A primeira linha deve ter cerca de 50 caracteres ou menos e conter uma |
| 136 | + breve da descrição da mudança. |
| 137 | +2. Mantenha a segunda linha em branco. |
| 138 | +3. Quebra todas as outras linhas em 72 colunas. |
| 139 | +4. Incluir `Fixes # N`, onde _N_ é o número do problema que o commit corrige |
| 140 | + se houver. |
| 141 | + |
| 142 | +Uma boa mensagem de confirmação pode ter a seguinte aparência: |
| 143 | + |
| 144 | +```text |
| 145 | +explain commit normatively in one line |
| 146 | +
|
| 147 | +Body of commit message is a few lines of text, explaining things |
| 148 | +in more detail, possibly giving some background about the issue |
| 149 | +being fixed, etc. |
| 150 | +
|
| 151 | +The body of the commit message can be several paragraphs, and |
| 152 | +please do proper word-wrap and keep columns shorter than about |
| 153 | +72 characters or so. That way `git log` will show things |
| 154 | +nicely even when it is indented. |
| 155 | +
|
| 156 | +Fixes #141 |
| 157 | +``` |
| 158 | + |
| 159 | +A primeira linha deve ser significativa, pois é o que as pessoas veem quando |
| 160 | +executam `git shortlog` ou` git log --oneline`. |
| 161 | + |
| 162 | +### Passo 5: Rebase |
| 163 | + |
| 164 | +Use `git rebase` (não `git merge`) para sincronizar seu trabalho de tempos em tempos. |
| 165 | + |
| 166 | +```shell |
| 167 | +% git fetch upstream |
| 168 | +% git rebase upstream/trunk |
| 169 | +``` |
| 170 | + |
| 171 | +### Passo 6: Teste |
| 172 | + |
| 173 | +Lembre-se sempre de [executar o servidor local](https://gohugo.io/getting-started/usage/#livereload), |
| 174 | +com isso, você pode ter certeza de que suas alterações não prejudicaram nada. |
| 175 | + |
| 176 | +### Passo 7: Push |
| 177 | + |
| 178 | +```shell |
| 179 | +% git push origin my-feature-branch |
| 180 | +``` |
| 181 | + |
| 182 | +Acesse https://github.com/yourusername/seleniumhq.github.io.git e |
| 183 | +clique em _Pull Request_ e preencha o formulário. **Por favor indique |
| 184 | +que você assinou o CLA** (consulte a Etapa 7). |
| 185 | + |
| 186 | +Os Pull Requests geralmente são revisados em alguns dias. Se houver |
| 187 | +comentários a abordar, aplique suas alterações em novos commits (de preferência |
| 188 | +[fixups](http://git-scm.com/docs/git-commit)) e envie para a mesma |
| 189 | +branch. |
| 190 | + |
| 191 | +### Passo 8: Integração |
| 192 | + |
| 193 | +Quando a revisão do código for concluída, um committer integrará seu PR no branch de tronco do repositório. Porque gostamos de manter um |
| 194 | +histórico linear no `trunk`, nós normalmente iremos dar Squash & Rebase no histórico da sua branch. |
| 195 | + |
| 196 | +## Comunicação |
| 197 | + |
| 198 | +Todos os detalhes sobre como se comunicar com os colaboradores do projeto |
| 199 | +e a comunidade em geral podem ser encontrados em https://selenium.dev/support |
0 commit comments