# Contributing to the Selenium site & documentation > Information on improving documentation and code examples for Selenium URL: https://deploy-preview-2974--selenium-dev.netlify.app/documentation/about/contributing/ Site index: https://deploy-preview-2974--selenium-dev.netlify.app/llms.txt --- Selenium is a big software project, its site and documentation are key to understanding how things work and learning effective ways to exploit its potential. This project contains both Selenium's site and documentation. This is an ongoing effort (not targeted at any specific release) to provide updated information on how to use Selenium effectively, how to get involved and how to contribute to Selenium. Contributions toward the site and docs follow the process described in the below section about contributions. --- The Selenium project welcomes contributions from everyone. There are a number of ways you can help: ## Report an issue When reporting a new issues or commenting on existing issues please make sure discussions are related to concrete technical issues with the Selenium software, its site and/or documentation. All of the Selenium components change quite fast over time, so this might cause the documentation to be out of date. If you find this to be the case, as mentioned, don't hesitate to create an issue for that. It also might be possible that you know how to bring up to date the documentation, so please send us a pull request with the related changes. If you are not sure about what you have found is an issue or not, please ask through the communication channels described at https://selenium.dev/support. ## What to Help With This repository holds both the Selenium site and its documentation. Read the guide for the area you want to change: * [Selenium site](https://deploy-preview-2974--selenium-dev.netlify.app/documentation/about/contributing/site/index.md): the home page, downloads, projects, blog, and other pages outside of the documentation. * [Documentation](https://deploy-preview-2974--selenium-dev.netlify.app/documentation/about/contributing/documentation/index.md): the pages under `/documentation`, their structure, and their translations. * [Code examples](https://deploy-preview-2974--selenium-dev.netlify.app/documentation/about/contributing/code_examples/index.md): creating runnable code examples and rendering them in the documentation. ## Contribution Mechanics The Selenium project welcomes new contributors. Individuals making significant and valuable contributions over time are made _Committers_ and given commit-access to the project. This guide will guide you through the contribution process. ### Step 1: Fork Fork the project [on GitHub](https://github.com/seleniumhq/seleniumhq.github.io) and check out your copy locally. ```shell % git clone git@github.com:seleniumhq/seleniumhq.github.io.git % cd seleniumhq.github.io ``` #### Dependencies: Hugo We use [Hugo](https://gohugo.io/) and the [Docsy theme](https://www.docsy.dev/) to build and render the site. You will need the “extended” Sass/SCSS version of the Hugo binary to work on this site. We recommend to use Hugo 0.169.0 . Please follow the [Install Hugo](https://www.docsy.dev/docs/getting-started/#install-hugo) instructions from Docsy. #### Dependencies: Go The Docsy theme is pulled in as a [Hugo Module](https://gohugo.io/hugo-modules/), so Hugo needs [Go](https://go.dev/dl/) to resolve it when you run `hugo server`. Install any version satisfying the minimum in `go.mod`. #### Dependencies: Node.js (optional, for the production CSS pipeline) Node.js is **not** required to preview the site with `hugo server` — in development mode Docsy skips PostCSS. You only need [Node.js](https://nodejs.org/) (any current release) if you want your local build to match the production CSS pipeline (autoprefixer/PostCSS), as run by `hugo --minify` in `build-site.sh`. In that case, run `npm install` in `website_and_docs` first. > **Note:** This may change with a future Hugo/Docsy upgrade. If theme assets > (e.g. Bootstrap/Font Awesome) move from Hugo Modules to npm packages, > `npm install` — and therefore Node.js — could become required for all builds, > not just the production pipeline. ### Step 2: Branch Create a feature branch and start hacking: ```shell % git checkout -b my-feature-branch ``` We practice HEAD-based development, which means all changes are applied directly on top of `dev`. ### Step 3: Make changes The repository contains the site and docs. To make changes to the site, work on the `website_and_docs` directory. To see a live preview of your changes, run `hugo server` on the site's root directory. ```shell % cd website_and_docs % hugo server ``` The project loads code from GitHub, if that code has been updated, and it isn't reflected in your preview, you can run hugo without the cache: `hugo server --ignoreCache` See [Style Guide](https://deploy-preview-2974--selenium-dev.netlify.app/documentation/about/style/index.md) for more information on our conventions for contribution, and the guides listed in [What to Help With](#what-to-help-with) for the area you are changing. ### Step 4: Commit First make sure git knows your name and email address: ```shell % git config --global user.name 'Santa Claus' % git config --global user.email 'santa@example.com' ``` **Writing good commit messages is important.** A commit message should describe what changed, why, and reference issues fixed (if any). Follow these guidelines when writing one: 1. The first line should be around 50 characters or less and contain a short description of the change. 2. Keep the second line blank. 3. Wrap all other lines at 72 columns. 4. Include `Fixes #N`, where _N_ is the issue number the commit fixes, if any. A good commit message can look like this: ```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 ``` The first line must be meaningful as it's what people see when they run `git shortlog` or `git log --oneline`. ### Step 5: Rebase Use `git rebase` (not `git merge`) to sync your work from time to time. ```shell % git fetch origin % git rebase origin/trunk ``` ### Step 6: Test Always remember to [run the local server](https://gohugo.io/getting-started/usage/#livereload), with this you can be sure that your changes have not broken anything. ### Step 7: Push ```shell % git push origin my-feature-branch ``` Go to https://github.com/yourusername/seleniumhq.github.io.git and press the _Pull Request_ and fill out the form. **Please indicate that you've signed the CLA**. To sign the CLA, visit [cla-assistant.io/SeleniumHQ/seleniumhq.github.io](https://cla-assistant.io/SeleniumHQ/seleniumhq.github.io) and click the "Sign in with GitHub to agree" button on the page. Pull requests are usually reviewed within a few days. If there are comments to address, apply your changes in new commits (preferably [fixups](http://git-scm.com/docs/git-commit)) and push to the same branch. ### Step 8: Integration When code review is complete, a committer will take your PR and integrate it on the repository's trunk branch. Because we like to keep a linear history on the trunk branch, we will normally squash and rebase your branch history. ## Communication All details on how to communicate with the project contributors and the community overall can be found at https://selenium.dev/support --- Section pages: - [Contributing to the Selenium site](https://deploy-preview-2974--selenium-dev.netlify.app/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/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/documentation/about/contributing/code_examples/index.md): How to create runnable code examples and render them in the documentation