Skip to content

logcheck/style-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

LogCheck Style Guide

About this guide

Omit needless words

The goal of this guide is to help you write source code that is readable, understandable, and maintainable by your peers. If it were possible to achieve this goal through a strict adherence to well-defined rules, there would be no need for this guide.

A good style guide provides guidance, but acknowledges that you and your peers are the ultimate arbiter of what is readable and what is not.

General Guidelines

Write readable code.

This is the most important rule.

A readable program can always be improved. If it has a syntax error, it can be corrected. If it has bugs, they can be fixed. If it is slow, it can be optimized. If it is insufficient, it can be enhanced.

The less readable a program is, the harder it is to change it. An unreadable program in any language might as well be written in machine code.

Avoid superfluous whitespace.

Trailing whitespace characters should be deleted. Blank lines should be empty. Files should end with a single \n.

Superfluous invisible characters make for noisy diffs.

Language-specific Guides

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •