Skip to content

Commit

Permalink
(cake-contribGH-11) Add information how to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger committed Dec 23, 2017
1 parent b2a6b5e commit 377d452
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 0 deletions.
17 changes: 17 additions & 0 deletions input/docs/contributing/how-to-build.md
Original file line number Diff line number Diff line change
@@ -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
19 changes: 19 additions & 0 deletions input/docs/contributing/how-to-contribute.md
Original file line number Diff line number Diff line change
@@ -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/)
8 changes: 8 additions & 0 deletions input/docs/contributing/how-to-release.md
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions input/docs/contributing/index.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
Order: 80
Description: Instructions how to contribute to the Cake Issues Addin.
---

@Html.Partial("_ChildPages")

0 comments on commit 377d452

Please sign in to comment.