# Contribuindo com o Site e Documentação do Selenium > Informações em como melhorar a documentação e exemplos de código para Selenium. URL: https://deploy-preview-2974--selenium-dev.netlify.app/pt-br/documentation/about/contributing/ --- Selenium é um grande projeto de software, seu site e documentação são fundamentais para entender como as coisas funcionam e aprender maneiras eficazes de explorar seu potencial. Este projeto contém o site e a documentação do Selenium. Isto é um esforço contínuo (não direcionado a nenhuma versão específica) para fornecer informações atualizadas sobre como usar o Selenium de forma eficaz, como se envolver e como contribuir para o Selenium. As contribuições para o site e documentação seguem o processo descrito na seção abaixo sobre contribuições. --- O projeto Selenium recebe contribuições de todos. Há um várias maneiras de ajudar: ## Reportar um problema Ao relatar um novo problema ou comentar sobre problemas existentes, por favor certifique-se de que as discussões estão relacionadas a questões técnicas concretas sobre o software Selenium, seu site e/ou documentação. Todos os componentes do Selenium mudam bastante rápido ao longo do tempo, então este pode fazer com que a documentação fique desatualizada. Se você observar que este é o caso, como mencionado, não hesite em criar um problema para isso. Também pode ser possível que você saiba como atualizar a documentação, então, envie-nos um Pull Request com a alteração. Se você não tem certeza se o que encontrou é um problema ou não, pergunte através dos canais de comunicação descritos em https://selenium.dev/support. ## What to Help With ### Creating Examples Examples that need to be added are marked with: _No example for this language yet ([add one](https://deploy-preview-2974--selenium-dev.netlify.app/pt-br/documentation/about/contributing/code_examples/index.md#creating-examples))._ We want to be able to run all of our code examples in the CI to ensure that people can copy and paste and execute everything on the site. So we put the code where it belongs in the [examples directory](https://github.com/SeleniumHQ/seleniumhq.github.io/blob/trunk/examples/). Each page in the documentation correlates to a test file in each of the languages, and should follow naming conventions. For instance examples for this page https://www.selenium.dev/documentation/webdriver/browsers/chrome/ get added in these files: * `"/examples/java/src/test/java/dev/selenium/browsers/ChromeTest.java"` * `"/examples/python/tests/browsers/test_chrome.py"` * `"/examples/dotnet/SeleniumDocs/Browsers/ChromeTest.cs"` * `"/examples/ruby/spec/browsers/chrome_spec.rb"` * `"/examples/javascript/test/browser/chromeSpecificCaps.spec.js"` Each example should get its own test. Ideally each test has an assertion that verifies the code works as intended. Once the code is copied to its own test in the proper file, it needs to be referenced in the markdown file. For example, the tab in Ruby would look like this: {{< tab header="Ruby" >}} {{< gh-codeblock path="/examples/ruby/spec/browsers/chrome_spec.rb#L8-L9" >}} {{< /tab >}} The line numbers at the end represent only the line or lines of code that actually represent the item being displayed. If a user wants more context, they can click the link to the GitHub page that will show the full context. Make sure that if you add a test to the page that all the other line numbers in the markdown file are still correct. Adding a test at the top of a page means updating every single reference in the documentation that has a line number for that file. Code examples may need a relevant website or web page to demonstrate the scenario. To ensure examples consistently work, it is recommended to use the test web pages available at https://www.selenium.dev/selenium/web/. Finally, make sure that the tests pass in the CI. ### Moving Examples Examples that need to be moved are marked with: _These examples are not yet tested in CI ([move them to the examples directory](https://deploy-preview-2974--selenium-dev.netlify.app/pt-br/documentation/about/contributing/code_examples/index.md#moving-examples))._ Everything from the [Creating Examples](#creating-examples) section applies, with one addition. Make sure the tab includes `text=true`. By default, the tabs get formatted for code, so to use markdown or other shortcode statements (like `gh-codeblock`) it needs to be declared as text. For most examples, the `tabpane` declares the `text=true`, but if some of the tabs have code examples, the `tabpane` cannot specify it, and it must be specified in the tabs that do not need automatic code formatting. ## Contribuições {#contribution-mechanics} O projeto Selenium dá as boas-vindas a novos contribuidores. Indivíduos fazendo contribuições significativas e valiosas ao longo do tempo são transformados em _Committers_ e recebem acesso de commit ao projeto. Este guia irá guiá-lo através do processo de contribuição. ### Passo 1: Fork Faça um fork do projeto [no GitHub](https://github.com/seleniumhq/seleniumhq.github.io) e faça checkout na sua cópia localmente. ```shell % git clone git@github.com:seleniumhq/seleniumhq.github.io.git % cd seleniumhq.github.io ``` #### Dependências: Hugo Usamos [Hugo](https://gohugo.io/) e [Docsy theme](https://www.docsy.dev/) para criar e gerar o website. Você vai necessitar de usar a versão "extended" Sass/SCSS do binário Hugo. Recomendamos a versão 0.169.0 . Por favor siga as instruções do Docsy [Install Hugo](https://www.docsy.dev/docs/getting-started/#install-hugo) #### Dependências: Go O tema Docsy é obtido como um [Hugo Module](https://gohugo.io/hugo-modules/), então o Hugo precisa do [Go](https://go.dev/dl/) para resolvê-lo ao executar `hugo server`. Instale qualquer versão que satisfaça o mínimo definido em `go.mod`. #### Dependências: Node.js (opcional, para o pipeline de CSS de produção) Node.js **não** é necessário para pré-visualizar o site com `hugo server` — no modo de desenvolvimento o Docsy ignora o PostCSS. Você só precisa do [Node.js](https://nodejs.org/) (qualquer versão atual) se quiser que o seu build local corresponda ao pipeline de CSS de produção (autoprefixer/PostCSS), executado por `hugo --minify` em `build-site.sh`. Nesse caso, execute `npm install` em `website_and_docs` primeiro. > **Nota:** Isso pode mudar em uma futura atualização do Hugo/Docsy. Se os assets do tema > (por exemplo, Bootstrap/Font Awesome) migrarem do Hugo Modules para pacotes npm, > `npm install` — e, portanto, o Node.js — pode se tornar necessário para todos os builds, > não apenas para o pipeline de produção. ### Passo 2: Branch Crie uma branch e comece a hackear: ```shell % git checkout -b my-feature-branch ``` Praticamos o desenvolvimento baseado em HEAD, o que significa que todas as mudanças são aplicadas diretamente no topo do `dev`. ### Passo 3: Faça mudanças O repositório contém o website e a documentação. Antes de começar a alterar coisas, por favor veja o resto dos passos para preparar as dependências e sub-módulos (veja os comandos abaixo). Para fazer alterações ao website, trabalha na pasta `website_and_docs`. Para ver uma previsão do aspecto do website, execute `hugo server` a partir da raíz do projecto. ```shell % git submodule update --init --recursive % cd website_and_docs % hugo server ``` See [Style Guide](https://deploy-preview-2974--selenium-dev.netlify.app/pt-br/documentation/about/style/index.md) for more information on our conventions for contribution ### Passo 4: Commit Primeiro, certifique-se de que o git saiba seu nome e endereço de e-mail: ```shell % git config --global user.name 'Santa Claus' % git config --global user.email 'santa@example.com' ``` **Escrever boas mensagens de commit é importante.** Uma mensagem de confirmação deve descrever o que mudou, por que e conter referência de problemas corrigidos (se houver). Siga estas diretrizes ao escrever um: 1. A primeira linha deve ter cerca de 50 caracteres ou menos e conter uma breve da descrição da mudança. 2. Mantenha a segunda linha em branco. 3. Quebra todas as outras linhas em 72 colunas. 4. Incluir `Fixes # N`, onde _N_ é o número do problema que o commit corrige se houver. Uma boa mensagem de confirmação pode ter a seguinte aparência: ```text explain commit normatively in one line Body of commit message is a few lines of text, explaining things in more detail, possibly giving some background about the issue being fixed, etc. The body of the commit message can be several paragraphs, and please do proper word-wrap and keep columns shorter than about 72 characters or so. That way `git log` will show things nicely even when it is indented. Fixes #141 ``` A primeira linha deve ser significativa, pois é o que as pessoas veem quando executam `git shortlog` ou` git log --oneline`. ### Passo 5: Rebase Use `git rebase` (não `git merge`) para sincronizar seu trabalho de tempos em tempos. ```shell % git fetch origin % git rebase origin/trunk ``` ### Passo 6: Teste Lembre-se sempre de [executar o servidor local](https://gohugo.io/getting-started/usage/#livereload), com isso, você pode ter certeza de que suas alterações não prejudicaram nada. ### Passo 7: Push ```shell % git push origin my-feature-branch ``` Acesse https://github.com/yourusername/seleniumhq.github.io.git e clique em _Pull Request_ e preencha o formulário. **Por favor indique que você assinou o CLA**. Para assinar o CLA, visite [cla-assistant.io/SeleniumHQ/seleniumhq.github.io](https://cla-assistant.io/SeleniumHQ/seleniumhq.github.io) e clique no botão "Sign in with GitHub to agree" na página. Os Pull Requests geralmente são revisados em alguns dias. Se houver comentários a abordar, aplique suas alterações em novos commits (de preferência [fixups](http://git-scm.com/docs/git-commit)) e envie para a mesma branch. ### Passo 8: Integração 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 histórico linear no `trunk`, nós normalmente iremos dar Squash & Rebase no histórico da sua branch. ## Comunicação Todos os detalhes sobre como se comunicar com os colaboradores do projeto e a comunidade em geral podem ser encontrados em https://selenium.dev/support --- Section pages: - [Contributing to the Selenium site](https://deploy-preview-2974--selenium-dev.netlify.app/pt-br/documentation/about/contributing/site/index.md): How to update the Selenium site pages outside of the documentation - [Contributing to the Selenium documentation](https://deploy-preview-2974--selenium-dev.netlify.app/pt-br/documentation/about/contributing/documentation/index.md): How the Selenium documentation is organized and how to change it - [Contributing code examples](https://deploy-preview-2974--selenium-dev.netlify.app/pt-br/documentation/about/contributing/code_examples/index.md): How to create runnable code examples and render them in the documentation