summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-07-06 10:25:46 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-07-06 10:25:46 +0200
commite00f5c9c0724001c6a550029587683aa30e8d626 (patch)
tree44fa35696bf67b18a08cfb62a47e79937df4fa82 /docs/README.md
parent477684022f6816e6d2a0358caa6432c4d6f65da5 (diff)
parent37c69054e294bf554be03cf7e4c01e1f586e6943 (diff)
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 9e89a0383..60a554e54 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,3 +1,13 @@
# Hugo Docs
Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang.
+
+## Branches
+
+* The `master` branch is the **current Hugo version** and will be auto-deployed to [gohugo.io/](https://gohugo.io/).
+* Anything not relevant to the current Hugo version goes into the `dev` branch.
+* Changes in [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs) will, in general, be merged once every release, but can be manually merged/cherry picked if needed. This goes both ways.
+* All contributions that is not tightly coupled with code changes, should be made directly to `hugoDocs`.
+* But we also merge PRs into [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs), but preferably changes that is related to the code in the PR itself
+
+To summarize, we have two branches in this repository: `master` (current Hugo) and `dev` (next Hugo).