diff options
| author | Carlos Chinchilla <cachinchilla@google.com> | 2023-11-09 18:11:07 +0000 |
|---|---|---|
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-11-09 18:11:07 +0000 |
| commit | 2825c77b6864445fa49c84ce4d623d8ea6360917 (patch) | |
| tree | fa9e824f909554812e931c1474ae6ca7bbf5a1f6 | |
| parent | e4b8396799e862b200465142a460d77e7280a392 (diff) | |
| download | pigweed-2825c77b6864445fa49c84ce4d623d8ea6360917.tar.gz | |
docs: Add Contribution Standards section
Mention what CL authors are responsible for.
Change-Id: I2b91c023be379eba5c58c84c4b1d3842aae99f6e
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/179171
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Carlos Chinchilla <cachinchilla@google.com>
| -rw-r--r-- | docs/code_reviews.rst | 11 | ||||
| -rw-r--r-- | docs/contributing/index.rst | 19 | ||||
| -rwxr-xr-x | pw_presubmit/py/pw_presubmit/pigweed_presubmit.py | 1 |
3 files changed, 31 insertions, 0 deletions
diff --git a/docs/code_reviews.rst b/docs/code_reviews.rst index 742a02b99..fcd42082c 100644 --- a/docs/code_reviews.rst +++ b/docs/code_reviews.rst @@ -24,6 +24,17 @@ Small changes Please follow the guidance in `Google's Eng-Practices Small CLs <https://google.github.io/eng-practices/review/developer/small-cls.html>`_. +Complete changes +================ +Please follow the guidance in :ref:`docs-contributing-contribution-standards`. +In summary, CLs must be complete, tested, and include documentation and unit +tests for new code, bug fixes, and any code changes that merit it. However, to +enable iterative work and small changes, ``TODO`` comments are acceptable. They +must include an explanation of the problem and an action to take. + +We will not take over incomplete changes to avoid shifting our focus. We may +reject changes that do not meet the criteria above. + ------------- For reviewers ------------- diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 816da7d07..006b76c69 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -91,6 +91,25 @@ 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. +.. _docs-contributing-contribution-standards: + +Contribution Standards +---------------------- +Contributions, i.e. CLs, are expected to be complete solutions, accompanied by +documentation and unit tests when merited, e.g. new code, bug fixes, or code +that changes some behavior. This also means that code changes must be tested. +Tests will avoid or minimize any negative impact to Pigweed users, while +documentation will help others learn about the new changes. + +We understand that you may have different priorities or not know the best way to +complete your contribution. In that case, reach out via our `chat room +<https://discord.gg/M9NSeTA>`_ or on the `mailing list +<https://groups.google.com/forum/#!forum/pigweed>`_ for help or `File a bug +<https://issues.pigweed.dev/issues?q=status:open>`_ +requesting fixes describing how this may be blocking you. Otherwise you risk +working on a CL that does not match our vision and could be rejected. To keep +our focus, we cannot adopt incomplete CLs. + .. _gerrit-commit-hook: Gerrit Commit Hook diff --git a/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py b/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py index 79f66f635..65f1d7f0e 100755 --- a/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py +++ b/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py @@ -1146,6 +1146,7 @@ _EXCLUDE_FROM_TODO_CHECK = ( r'.gitignore$', r'.pylintrc$', r'\bdocs/build_system.rst', + r'\bdocs/code_reviews.rst', r'\bpw_assert_basic/basic_handler.cc', r'\bpw_assert_basic/public/pw_assert_basic/handler.h', r'\bpw_blob_store/public/pw_blob_store/flat_file_system_entry.h', |