diff options
author | Keir Mierle <keir@google.com> | 2020-03-19 02:03:51 -0700 |
---|---|---|
committer | CQ Bot Account <commit-bot@chromium.org> | 2020-03-19 16:19:56 +0000 |
commit | 086ef1cdc4dce2a2ebda4b15fc844a963236166d (patch) | |
tree | 6ea38393bc5f3f48f791d2930ed0403e0aa288cc /CONTRIBUTING.md | |
parent | 2c7657a1ba1461712f51f0fd588be447b5f3fa4f (diff) | |
download | pigweed-086ef1cdc4dce2a2ebda4b15fc844a963236166d.tar.gz |
docs: Various refinements ahead of launch
This is a series of changes across the documentation to improve the
overall first-user experience. Key changes:
1. New "Express setup" section in the "Getting Started" page.
2. Rename and reorder the left-hand menu bar components
3. Fix various copyright dates
4. Add presubmit animated gif to the pw_presubmit docs
Change-Id: I22a75ace8c2be15a6e5890d6e1b3618a1d53eefa
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db260a06a..2670eedfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,16 +6,18 @@ please reach out on the [mailing list](mailto:pigweed@googlegroups.com) first to ensure the changes make sense for upstream. We generally go through a design phase before making large changes. +Before participating in our community, please take a moment to review our [code +of conduct](CODE_OF_CONDUCT.md). We expect everyone who interacts with the +project to respect these guidelines. + Pigweed contribution overview: 1. One-time contributor setup: - * Sign the [Contributor License - Agreement](https://cla.developers.google.com/). - * Install the [gerrit commit hook](CONTRIBUTING.md#gerrit-commit-hook) to - automatically add a Change-ID to your CL. + * Sign the [Contributor License Agreement](https://cla.developers.google.com/). + * Install the [Gerrit commit hook](CONTRIBUTING.md#gerrit-commit-hook) to + automatically add a `Change-Id: ...` line to your commit * Install the Pigweed presubmit check hook (`pw presubmit --install`). (recommended) - 2. Ensure all files include a correct [copyright+license - header](CONTRIBUTING.md#source-code-headers). + 2. Ensure all files include a correct [copyright and license header](CONTRIBUTING.md#source-code-headers). 2. Upload the change with `git push origin HEAD:refs/for/master`. 3. Address any reviewer feedback by amending the commit (`git commit --amend`) 4. Submit change to CI builders to merge. @@ -34,7 +36,7 @@ again. ## Gerrit Commit Hook -Gerrit requires all changes to have a Change-ID tag at the bottom of each CL. +Gerrit requires all changes to have a `Change-Id` tag at the bottom of each CL. You should set this up to be done automatically using the instructions below. **Linux/macOS**<br/> @@ -73,7 +75,7 @@ browsers. Apache header for C and C++ files: ```javascript -// Copyright 2019 The Pigweed Authors +// Copyright 2020 The Pigweed Authors // // Licensed under the Apache License, Version 2.0 (the "License"); you may not // use this file except in compliance with the License. You may obtain a copy of @@ -91,7 +93,7 @@ Apache header for C and C++ files: Apache header for Python and GN files: ```python -# Copyright 2019 The Pigweed Authors +# Copyright 2020 The Pigweed Authors # # Licensed under the Apache License, Version 2.0 (the "License"); you may not # use this file except in compliance with the License. You may obtain a copy of |