From 377d452a409e5dce87e3e1c464b41a68105b88eb Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Sat, 23 Dec 2017 22:06:20 +0100 Subject: [PATCH] (GH-11) Add information how to contribute --- input/docs/contributing/how-to-build.md | 17 +++++++++++++++++ input/docs/contributing/how-to-contribute.md | 19 +++++++++++++++++++ input/docs/contributing/how-to-release.md | 8 ++++++++ input/docs/contributing/index.cshtml | 6 ++++++ 4 files changed, 50 insertions(+) create mode 100644 input/docs/contributing/how-to-build.md create mode 100644 input/docs/contributing/how-to-contribute.md create mode 100644 input/docs/contributing/how-to-release.md create mode 100644 input/docs/contributing/index.cshtml diff --git a/input/docs/contributing/how-to-build.md b/input/docs/contributing/how-to-build.md new file mode 100644 index 000000000..9c637c273 --- /dev/null +++ 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 \ No newline at end of file diff --git a/input/docs/contributing/how-to-contribute.md b/input/docs/contributing/how-to-contribute.md new file mode 100644 index 000000000..8004ea3dd --- /dev/null +++ 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/) \ No newline at end of file diff --git a/input/docs/contributing/how-to-release.md b/input/docs/contributing/how-to-release.md new file mode 100644 index 000000000..c56e6cf5e --- /dev/null +++ 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 \ No newline at end of file diff --git a/input/docs/contributing/index.cshtml b/input/docs/contributing/index.cshtml new file mode 100644 index 000000000..eab1f73a5 --- /dev/null +++ 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") \ No newline at end of file