diff options
| author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-12-15 10:37:36 +0100 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-12-15 10:37:36 +0100 |
| commit | 67f3aa72cf9aaf3d6e447fa6bc12de704d46adf7 (patch) | |
| tree | 6d7019f6a0753b251a1c5c84e87f4007eb13b2f1 /docs/README.md | |
| parent | 0947cf958358e5a45b4f605e2a5b2504896fa360 (diff) | |
| parent | 2e711a28c71e8667258e5ab824f9b9a71c261b0a (diff) | |
Merge commit '2e711a28c71e8667258e5ab824f9b9a71c261b0a'
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/README.md b/docs/README.md index 7ca9d734c..a2c767b7b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,16 +13,16 @@ 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: +Spelling fixes are most welcomed, and if you want to contribute longer sections to the documentation, it would be great if you had the following criteria 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. +* For example, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great. 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 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. -* The `next` branch is where we store changes that is related to the next Hugo release. This can be previewed here: https://next--gohugoio.netlify.com/ +* The `next` branch is where we store changes that are related to the next Hugo release. This can be previewed here: https://next--gohugoio.netlify.com/ ## Build |