diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2021-01-02 12:07:21 +0100 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2021-01-02 12:07:21 +0100 |
| commit | 9d76709713a05991236bee606da36fbb922ccfc0 (patch) | |
| tree | 29d728c2ac9c1ddd141c9739c8e7e51da5929341 /CONTRIBUTING.md | |
| parent | 30ba87fa1531d6accf223552d7e65955e1434537 (diff) | |
| download | river-9d76709713a05991236bee606da36fbb922ccfc0.tar.gz river-9d76709713a05991236bee606da36fbb922ccfc0.tar.xz | |
docs: update stance on line length
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b12c11b..1d4db90 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,11 +35,11 @@ For further details regarding commit style and git history see Please follow the [Zig Style Guide](https://ziglang.org/documentation/master/#Style-Guide) -and run `zig fmt` before every commit. With regards to line length, consider 100 -characters to be a hard upper limit and 80 or less to be the goal. Note that -inserting a trailing comma after the last parameter in function calls, struct -declarations, etc. will cause `zig fmt` to wrap those lines. I highly recommend -configuring your editor to run `zig fmt` on write. +and run `zig fmt` before every commit. With regards to line length, keep it +under 100 columns in general but prioritize readability over adhering to a +strict limit. Note that inserting a trailing comma after the last parameter in +function calls, struct declarations, etc. will cause `zig fmt` to wrap those +lines. I highly recommend configuring your editor to run `zig fmt` on write. On a higher level, prioritize simplicity of code over nearly everything else. Performance is only a valid reason for code complexity if there are profiling |
