summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBernhard Posselt <dev@bernhard-posselt.com>2016-03-25 22:40:46 +0100
committerBernhard Posselt <dev@bernhard-posselt.com>2016-03-25 22:40:46 +0100
commit7a5157d5c57d676ef4992a0f0708c77728555bb2 (patch)
tree4ff7a0d6ef010d782bb92416555f14ef6bd68091 /CONTRIBUTING.md
parenta16e1884bdd74b3eb08f6f6fc041e56dbc09b35c (diff)
explain makefile in contributing markdown
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index eeee4b826..207a0f2eb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -97,6 +97,22 @@ In general it's a good idea to **first create an issue where you explain why, wh
That way we can talk about the problem first and discuss the implementation (and of course help you with your code)
+To get started after cloning the repository, install the [development dependencies](https://github.com/owncloud/news#development-dependencies) and run:
+
+ make
+
+in the app directory to fetch all dependencies and compile the JavaScript. The News app uses Composer for PHP dependencies, Gulp for building the JavaScript "binary" and Bower/npm as JavaScript package manager. For more information on JavaScript development [check out the README.md in the js folder](https://github.com/owncloud/news/blob/master/js/README.md)
+
+For running all tests suites you can run:
+
+ make test
+
+Packaging is done via:
+
+ make dist
+
+The packages are inside the top level **build/artifacts** folder
+
### Stuff To Work On
Check [the plugin section on the wiki](https://github.com/owncloud/news/wiki#requested-and-needs-contributors) for finding ideas to work on which should be realized separately via a plugin or app.