From 2549c3c80eadb50fcdf9bde2f6ee165d0c8937b8 Mon Sep 17 00:00:00 2001 From: Jacob Hoffman-Andrews Date: Thu, 31 Aug 2017 09:22:50 -0700 Subject: [PATCH] Recommend avoiding named returns. (#3027) --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e1c5b063..dcfe4f80f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,7 @@ Thanks for helping us build Boulder! This page contains requirements and guideli # Patch Guidelines * 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. +* Avoid named return values. See [#3017](https://github.com/letsencrypt/boulder/pull/3017) for an example of a subtle problem they can cause. * Do not include `XXX`s or naked `TODO`s. Use the formats: ``` // TODO(): Hoverboard + Time-machine unsupported until upstream patch.