Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

75 lines (53 loc) · 2.73 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Get your copy

To start contributing you need to clone this repository. Use the following command that will also clone the submodules used.

git clone --recurse-submodules --depth 1 https://github.com/docker/get-involved

Running the website locally

Building and running the site locally requires a recent extended version of Hugo. You can find out more about how to install Hugo for your environment in our Getting started guide.

You need a recent extended version of Hugo to do local builds and preview the website. We recommend using version 0.75.0 or later. If you install from the release page, make sure to get the extended Hugo version. The extended versions support SCSS; you may need to scroll down the list of releases to see it.

For comprehensive Hugo documentation, see gohugo.io.

Once you've made your working copy of the site repo, from the repo root folder, run:

hugo server

Troubleshooting

If you have not cloned this repository as suggested above, you may face the following error during the run:

➜ hugo server -D
Start building sites … 
Built in 1079 ms
Error: Error building site: "/home/get-involved/content/en/_index.html:7:1": failed to extract shortcode: template for shortcode "blocks/cover" not found

This is primarily because you have not yet cloned the submodules used in the repository. In order to fix the issue run the following command and retry:

git submodule update --init --recursive

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.