Merge pull request cake-contrib#26 from cake-contrib/feature/contribu…

…tion (cake-contribGH-11) Add information how to contribute
pascalberger · Dec 27, 2017 · 9b8d435 · 9b8d435
2 parents b2a6b5e + 377d452
commit 9b8d435
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 0 deletions.
diff --git a/input/docs/contributing/how-to-build.md b/input/docs/contributing/how-to-build.md
@@ -0,0 +1,17 @@
+---
+Order: 20
+Title: How to build addins
+Description: Instructions how to build individual Cake Issues addins.
+---
+To build this a package we are using Cake.
+
+On Windows PowerShell run:
+
+```powershell
+./build
+```
+
+On OSX/Linux run:
+
+```bash
+./build.sh
diff --git a/input/docs/contributing/how-to-contribute.md b/input/docs/contributing/how-to-contribute.md
@@ -0,0 +1,19 @@
+---
+Order: 10
+Title: How to contribute
+Description: Instructions how to contribute to Cake Issues addins.
+---
+The repositories are using [GitFlow] with default configuration.
+Development is happening on `develop` branch.
+
+To contribute:
+
+* Fork this repository.
+* Create a feature branch from `develop`.
+* Implement your changes.
+* Push your feature branch.
+* Create a pull request.
+
+For getting started see issues marked with `Up-for-grabs` in the individual repositories.
+
+[GitFlow]: (http://nvie.com/posts/a-successful-git-branching-model/)
diff --git a/input/docs/contributing/how-to-release.md b/input/docs/contributing/how-to-release.md
@@ -0,0 +1,8 @@
+---
+Order: 20
+Title: How to release addins
+Description: Instructions how to release individual Cake Issues addins.
+---
+See [Cake.Recipe documentation] how to create a new release of this addin.
+
+[Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release
diff --git a/input/docs/contributing/index.cshtml b/input/docs/contributing/index.cshtml
@@ -0,0 +1,6 @@
+---
+Order: 80
+Description: Instructions how to contribute to the Cake Issues Addin.
+---
+
+@Html.Partial("_ChildPages")