diff options
| -rw-r--r-- | doc/styleguide.txt | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/styleguide.txt b/doc/styleguide.txt index b994ff18..39aedf82 100644 --- a/doc/styleguide.txt +++ b/doc/styleguide.txt @@ -3,9 +3,16 @@ Coding Style Guide Introduction ------------ -This document attempts to explain the basic styles and patterns that are used in the bash completion. New code should try to conform to these standards so that it is as easy to maintain as existing code. Of course every rule has an exception, but it's important to know the rules nonetheless! - -This is particularly directed at people new to the bash completion codebase, who are in the process of getting their code reviewed. Before getting a review, please read over this document and make sure your code conforms to the recommendations here. +This document attempts to explain the basic styles and patterns that +are used in the bash completion. New code should try to conform to +these standards so that it is as easy to maintain as existing code. +Of course every rule has an exception, but it's important to know +the rules nonetheless! + +This is particularly directed at people new to the bash completion +codebase, who are in the process of getting their code reviewed. +Before getting a review, please read over this document and make +sure your code conforms to the recommendations here. Indentation ----------- |