summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-03-11 20:40:26 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-03-11 20:40:26 +0100
commit95d62004a07d8bb6d2b94a56112fd419db7eeb65 (patch)
treeb0958861ece2af8aa1b3e14b604c4c49f0728793 /docs/README.md
parent68bf1511f2be39b6576d882d071196e477c72c9f (diff)
parentc0290655825e7bb36e13fb39f89d85b392cf1adc (diff)
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index d82776de3..5f47e8a1e 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -10,6 +10,12 @@ Note that this repository contains solely the documentation for Hugo. For contri
*Pull requests shall **only** contain changes to the actual documentation. However, changes on the code base of Hugo **and** the documentation shall be a single, atomic pull request in the [hugo](https://github.com/gohugoio/hugo) repository.*
+Spelling fixes are most welcomed, and if you want to contribute longer sections to the documentation, it would be great if you had these in mind when writing:
+
+* Short is good. People go to the library to read novels. If there is more than one way to _do a thing_ in Hugo, describe the current _best practice_ (avoid "… but you can also do …" and "… in older versions of Hugo you had to …".
+* For examples, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great, but don't list long and similar examples just so people can use them on their sites.
+* Hugo has users from all over the world, so an easy to understand and [simple English](https://simple.wikipedia.org/wiki/Basic_English) is good.
+
## Branches
* The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.