path: root/doc/coding_style.mdwn
diff options
authorJoey Hess2016-05-17 14:57:05 -0400
committerJoey Hess2016-05-17 14:57:05 -0400
commit2272bd612578592d714221f100d49163ec8b4389 (patch)
tree4a2e970b851cac5d2c212f90a2c5cc98ae62a748 /doc/coding_style.mdwn
parenta3719892565791715738cbf5acb6769d450fc6d5 (diff)
Diffstat (limited to 'doc/coding_style.mdwn')
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/coding_style.mdwn b/doc/coding_style.mdwn
index 92553d76..bf127fe0 100644
--- a/doc/coding_style.mdwn
+++ b/doc/coding_style.mdwn
@@ -2,6 +2,20 @@ If you do nothing else, avoid use of partial functions from the Prelude!
`import Utility.PartialPrelude` helps avoid this by defining conflicting
functions for all the common ones. Also avoid `!!`, it's partial too.
+The rest of this coding style is followed to keep the code in Propellor
+consistent. You don't have to follow these rules in your own config.hs, or
+in Propellor modules that you don't intend to get merged into mainstrain
+Start a module with a comment indicating what software it provides
+properties for, and who maintains the module.
+ -- | Maintainer: Your Name Here <>
+ --
+ -- Support for the Foo daemon <>
+ module Propellor.Property.Foo
Use tabs for indentation.
Code should make sense with any tab stop setting, but 8 space tabs are