From 81b03f0be097eb2ed1f793b168b75b942211ca94 Mon Sep 17 00:00:00 2001 From: webwarrior-ws Date: Wed, 15 Apr 2026 10:24:42 +0200 Subject: [PATCH 1/3] docs/WorkflowGuidelines.md: remove duplicate rule About braces around single statement. This should have been done in [1]. [1] https://github.com/tarsgate/conventions/pull/238 --- docs/WorkflowGuidelines.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/WorkflowGuidelines.md b/docs/WorkflowGuidelines.md index a114a2384..afa07705e 100644 --- a/docs/WorkflowGuidelines.md +++ b/docs/WorkflowGuidelines.md @@ -12,7 +12,6 @@ * In general, we prefer verbose code (even if it's longer) than short & clever code. This means: * We dislike short variable names (if there's some ambiguity on what your variable represents, then choose a longer and more descriptive name). - * In languages that have optional braces for `if/else` statements (e.g. C#, TypeScript), we prefer to add them even if the code block will only contain one line. This way, when the next developer adds more lines to it later it's less work for him and doesn't cause unnecessary git-blame noise. * Group import declarations (e.g. `open` in F# and `using` in C#) in three buckets: * The first group for the namespaces that come from the base class libraries. From fc93fbbb85fa4c87b622f17a56b6cf52729fab48 Mon Sep 17 00:00:00 2001 From: webwarrior-ws Date: Wed, 15 Apr 2026 10:44:13 +0200 Subject: [PATCH 2/3] docs/WorkflowGuidelines.md: collapse 1-item list Collapse list, that now has only one item after removal in previous commit, into single paragraph. --- docs/WorkflowGuidelines.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/WorkflowGuidelines.md b/docs/WorkflowGuidelines.md index afa07705e..95c88494f 100644 --- a/docs/WorkflowGuidelines.md +++ b/docs/WorkflowGuidelines.md @@ -10,8 +10,7 @@ * Otherwise, PR description could be a summary of all the commits, or choose the most important commit to align with (in case the other commits don't add much substance). In this case, PR has to be merged with "Create a merge commit" button. -* In general, we prefer verbose code (even if it's longer) than short & clever code. This means: - * We dislike short variable names (if there's some ambiguity on what your variable represents, then choose a longer and more descriptive name). +* In general, we prefer verbose code (even if it's longer) than short & clever code. For example, we dislike short variable names (if there's some ambiguity on what your variable represents, then choose a longer and more descriptive name). * Group import declarations (e.g. `open` in F# and `using` in C#) in three buckets: * The first group for the namespaces that come from the base class libraries. From d9269d5f5edc43412a469d51455874616fbd5712 Mon Sep 17 00:00:00 2001 From: webwarrior-ws Date: Thu, 16 Apr 2026 10:27:56 +0200 Subject: [PATCH 3/3] WIP --- docs/WorkflowGuidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/WorkflowGuidelines.md b/docs/WorkflowGuidelines.md index 95c88494f..f93e5ec0c 100644 --- a/docs/WorkflowGuidelines.md +++ b/docs/WorkflowGuidelines.md @@ -181,7 +181,7 @@ } ``` - * Always use curly braces when you can (for readability and diff-noise reduction for upcoming changes): + * In languages that have optional braces for `if/else` statements (e.g. C#, TypeScript), we prefer to add them even if the code block will only contain one line. This way, when the next developer adds more lines to it later it's less work for him and doesn't cause unnecessary git-blame noise. Example (with bad practice): ```typescript