Skip to content

Commit f56de5a

Browse files
committed
docs: remove style-guide quote and add rationale
The first paragraph with quote from Mike McQuaid was replaced with a brief paragraph. The new text aims to indicate why a style convention guide is useful and that it can be amended.
1 parent d91065d commit f56de5a

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

STYLE_GUIDE.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
# Fortran stdlib Style Guide
22

3-
> [A]utomate and codify as much as you possibly can while remembering that the human touch is still necessary to praise
4-
> and be kind to your contributors.
5-
> Let robots handle your project’s pedantry and humans handle your project’s empathy.
6-
7-
-- @mikemcquaid, [Homebrew] project leader<sup>[1]</sup>
8-
9-
[1]: https://mikemcquaid.com/2018/06/05/robot-pedantry-human-empathy/
10-
[Homebrew]: https://brew.sh
3+
Adopting a consistent style can improve code legibility through the choice of good naming conventions.
4+
In addition, style checks will be run during CI to flag any severe non-conformance.
5+
This allows code review discussions to focus on semantics and substance rather than pedantry.
6+
Consistent whitespace usage, and not poluting line endigs with trailing white space makes `git diff`s considerably more legible.
7+
This style guide is a living document and proposed changes may be adopted after discussing them and coming to a consensus.
118

129
## File naming conventions
1310

0 commit comments

Comments
 (0)