TOPIO/BigWhoop
TOPIO/BigWhoop
4
1
Fork 0
Code Issues 26 Pull requests 1 Projects 6 Releases Packages Wiki Activity

Update 'Coding Style'

Patrick Vogler 2023-06-20 14:32:35 +00:00
parent 17cf62ab5b
commit 28a4fd80ff
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Coding-Style.md

@ -26,4 +26,12 @@ This document discusses practices and style for programmers working on the BigWh
- [Syntactic Conventions](#syntactic_conventions)
- [Names](#names)
## The Single Most Important Rule
## The Single Most Important Rule
Above all, the following rule from the GNOME developer documentation should always be followed.
>The single most important rule when writing code is this: check the surrounding code and try to imitate it.
>
>As a maintainer it is dismaying to receive a patch that is obviously in a different coding style to the surrounding code. This is >disrespectful, like someone tromping into a spotlessly-clean house with muddy shoes.
>
>So, whatever this document recommends, if there is already written code and you are contributing to it, keep its current style >consistent even if it is not your favorite style.
>
>Most importantly, do not make your first contribution to a project a change in the coding style to suit your taste. That is >incredibly disrespectful.