From 61d418b567b40377819c31193fbedcf5b25d40a1 Mon Sep 17 00:00:00 2001 From: Jacob Hoffman-Andrews Date: Mon, 19 Oct 2026 12:47:30 -0700 Subject: [PATCH 1/2] CONTRIBUTING.md: comment column guidance --- docs/CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 02711e91150..3a2a402f66a 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -57,8 +57,15 @@ conversation once the external conditions are met. Since our repository is configured to require all conversations be resolved before merging, this acts as a protection against early merges. -# Patch Guidelines - +# Style + +* We generally try to follow the [Google Go Style Guide] for new and updated + code. +* Newly added comments should be wrapped to 80 columns, with exceptions for URLs, + quotes from other documents, or other things that would be awkward to wrap. + When editing an existing comment, use discretion as to whether it needs to be + re-wrapped. Growing slightly above 80 columns is fine in the interests of + clear diffs. * Please include helpful comments. No need to gratuitously comment clear code, but make sure it's clear why things are being done. Include information in your pull request about what you're trying to accomplish with your patch. @@ -74,6 +81,8 @@ a protection against early merges. // TODO(@githubusername): Enable hoverboard kickflips once interface is stable. ``` +[gostyle]: https://google.github.io/styleguide/go/index + # Squash merging Once a pull request is approved and the tests are passing, the author or any From f6009b7999bd5e0ff911c347963e28e68e2b4ce6 Mon Sep 17 00:00:00 2001 From: Jacob Hoffman-Andrews Date: Tue, 20 Oct 2026 15:00:10 -0700 Subject: [PATCH 2/2] fix link --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3a2a402f66a..1af3cf1e3f6 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -59,7 +59,7 @@ a protection against early merges. # Style -* We generally try to follow the [Google Go Style Guide] for new and updated +* We generally try to follow the [Google Go Style Guide][gostyle] for new and updated code. * Newly added comments should be wrapped to 80 columns, with exceptions for URLs, quotes from other documents, or other things that would be awkward to wrap.