summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess2014-10-31 11:00:14 -0400
committerJoey Hess2014-10-31 11:00:14 -0400
commit4e070b4d7ff0e57a06e135228f539e3b2db398ea (patch)
tree7108cf8c662e09feec5e02e57383b39978df5075 /doc
parent6b64bfddab4b31211b8057d2d149449c20ffb3b6 (diff)
parent5b3a0d70260d570bd7cfc71312a7ebbdf544e0c7 (diff)
Merge branch 'joeyconfig'
Diffstat (limited to 'doc')
-rw-r--r--doc/README.mdwn6
-rw-r--r--doc/contributing.mdwn15
-rw-r--r--doc/index.mdwn2
3 files changed, 18 insertions, 5 deletions
diff --git a/doc/README.mdwn b/doc/README.mdwn
index 115feaef..a0742f78 100644
--- a/doc/README.mdwn
+++ b/doc/README.mdwn
@@ -62,11 +62,7 @@ see [configuration for the Haskell newbie](https://propellor.branchable.com/hask
Now they'll automatically update every 30 minutes, and you can
`git commit -S` and `git push` changes that affect any number of
hosts.
-10. Write some neat new properties and send patches to <propellor@joeyh.name>!
- Use `git commit --signoff` to certify that your additions to propellor
- are released under its BSD license.
- See <https://propellor.branchable.com/contributing> for coding styles,
- etc.
+10. Write some neat new properties and send patches!
## debugging
diff --git a/doc/contributing.mdwn b/doc/contributing.mdwn
new file mode 100644
index 00000000..33b34a61
--- /dev/null
+++ b/doc/contributing.mdwn
@@ -0,0 +1,15 @@
+Propellor is free software, released under a BSD license. Anyone is free to
+modify and distribute it; indeed doing so is a fundamental part of how
+propellor is configured and used.
+
+You don't have to contribute your patches, but you're encouraged to do so;
+let's all make propellor awesome together! Patches can be sent to
+<propellor@joeyh.name> or pull requests can be posted to [[todo]].
+
+To certify that a change is released under propellor's BSD license,
+you can use `git commit --signoff`.
+
+Propellor has its own [[coding_style]], which you are encouraged to follow
+-- at least when you want to get a patch merged into propellor.
+When writing code for your own internal use, feel free to ignore all the
+rules, except the ones about avoiding partial functions.
diff --git a/doc/index.mdwn b/doc/index.mdwn
index 5311baf7..f5fd8806 100644
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -26,6 +26,8 @@ hosts = -- (o) `
Propellor is free software, licensed under the BSD license.
+You are encouraged to send patches and improve it. See [[contributing]].
+
## news
[[!inline pages="news/* and !*/Discussion" show="4" archive=yes]]