expand contributing

3 files changed, 96 insertions, 37 deletions

diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
new file mode 100644
index 000000000..735b25f92
--- /dev/null
+++ b/CONTRIBUTION.md
@@ -0,0 +1,92 @@
+# Contributing
+Please read carefully ;)
+
+## Bugs
+
+### Before reporting bugs
+
+* We do not support Internet Explorer and Safari (Patches accepted though, except for IE < 10)
+* We do **not support the server-side encryption app** (use client side encryption instead)
+* Get the newest version of the News app
+* Clear your PHP opcode cache if you use any by restarting your webserver. This affects any version of PHP >=5.5
+* [Check if they have already been reported](https://github.com/owncloud/news/issues?state=open)
+* [Check if your problem is covered in the FAQ section](https://github.com/owncloud/news#faq) or [Updating notices](https://github.com/owncloud/news#updating-notices)
+
+If you are not able to add a feed because its XML *does not validate* (see [this issue](https://github.com/owncloud/news/issues/133) for an example),
+check if:
+
+* It is a valid RSS by running it through the [W3C validator](http://validator.w3.org/feed/)
+* You are able to add the feed in other feed readers
+
+
+### When reporting bugs
+
+* Enable debug mode by putting this at the bottom of **config/config.php**
+
+      DEFINE('DEBUG', true);
+
+* Turn on debug level debug by adding **"loglevel" => 0,** to your **config/config.php** and reproduce the problem
+* check **data/owncloud.log**
+
+Please provide the following details so that your problem can be fixed:
+
+* **data/owncloud.log** (important!)
+* ownCloud version
+* News version
+* Browser and version
+* PHP version
+* Distribution
+
+
+## Development
+
+We usually hang out on **irc.freenode.net** in the **#owncloud-dev** chat room. Just ping [Raydiation](https://github.com/Raydiation/) or [cosenal](https://github.com/cosenal) or write us a mail directly. Mail addresses are listed on our GitHub profiles.
+
+### Project structure
+
+
+* **admin/**: Admin related parts which hook up the News app in the admin area. The HTML is in **templates/admin.php** folder, the JavaScript is in **js/admin/Admin.js**, CSS in **css/admin.css**. Both CSS and JavaScript don't need to be recompiled unlike everything else. The controller that hooks up the template is located in **controller/admincontroller.php**. **admin/admin.php** is just there to wire up the controllers on the admin page which does not support the App Framework.
+
+* **appinfo/**: Contains metadata related things, like names, versions, database structure, routes and the container that tells ownCloud how the app is assembled
+
+* **articleenhancer/**: All the code that deals with fetching additional content from websites and transforming RSS/Atom content. Keep in mind that some stuff is done by picoFeed, the feed library that is used in ownCloud News.
+
+* **bin/**: Git hooks and the custom Python updater
+
+* **build/**: The folder where complete archives are saved when running make appstore
+
+* **command/**: occ commands that can be called like ./occ news:my_command
+
+* **config/**: The code that reads the news config.ini file which is located in the data directory and can also be edited in the admin interface
+
+* **controller/**: The stuff that reacts when a request comes in to a certain URL. URLs are defined in **appinfo/routes.php** and link to controllers.
+
+* **cron/**: The code that is run when the ownCloud cron is being called.
+
+* **css/**: All the CSS used in the project. Except the admin.css file everything needs to be minified first using Grunt, see the **js/README.md** file for more information
+
+* **db/**: SQL queries and data objects.
+
+* **explore/**: Code that allows you to hook up custom explore pages and JSON configuration files what is displayed on the default explore page
+
+* **fetcher/**: The code part that receives the feed url and uses picoFeed to fetch the content. Then things are mapped to Feed and Item objects that can be stored in the database.
+
+* **hooks/**: Code to react to changes in ownCloud, e.g. what to do when a user is deleted
+
+* **http/**: Custom response classes, e.g. to download a textfile
+
+* **img/**: Pictures for thumbnails and icons
+
+* **js/**: All the JavaScript files, libs and tests. Needs to be compiled using Grunt first, instructions are in the **js/README.md** file. The app is built using [Angular](https://angularjs.org/)
+
+* **l10n/**: Automatically generated translation files. Don't edit them directly, instead go to Transifex which is a web interface that handles our translations, e.g. the German translation page is located here: [https://www.transifex.com/projects/p/owncloud/translate/#de/news/36802042](https://www.transifex.com/projects/p/owncloud/translate/#de/news/36802042). For other languages just replace the language code in the url.
+
+* **plugin/**:
+
+* **service/**: The most important part. Contains the app logic and validation, like what happens when you add or update a feed.
+
+* **templates/**: All the HTML that is used in the app
+
+* **utility/**: Stuff that did not fit anywhere, mostly factories that are needed to deal with 3rdparty libraries like picoFeed, but also OPML exporters and updater classes
+
+* **vendor/**: 3rdparty libraries that are managed using composer.
\ No newline at end of file
diff --git a/README.md b/README.md
index 2fe1af049..e8eeea458 100644
--- a/README.md
+++ b/README.md
@@ -45,40 +45,7 @@ The minimum PHP version will be the [lowest supported version that still receive
 * MySql
 
 ## Bugs
-
-### Before reporting bugs
-
-* We do not support Internet Explorer and Safari (Patches accepted though, except for IE < 10)
-* We do **not support the server-side encryption app** (use client side encryption instead)
-* Get the newest version of the News app
-* Clear your PHP opcode cache if you use any by restarting your webserver. This affects any version of PHP >=5.5
-* [Check if they have already been reported](https://github.com/owncloud/news/issues?state=open)
-* [Check if your problem is covered in the FAQ section](https://github.com/owncloud/news#faq) or [Updating notices](https://github.com/owncloud/news#updating-notices)
-
-If you are not able to add a feed because its XML *does not validate* (see [this issue](https://github.com/owncloud/news/issues/133) for an example),
-check if:
-
-* It is a valid RSS by running it through the [W3C validator](http://validator.w3.org/feed/)
-* You are able to add the feed in other feed readers
-
-
-### When reporting bugs
-
-* Enable debug mode by putting this at the bottom of **config/config.php**
-
-      DEFINE('DEBUG', true);
-
-* Turn on debug level debug by adding **"loglevel" => 0,** to your **config/config.php** and reproduce the problem
-* check **data/owncloud.log**
-
-Please provide the following details so that your problem can be fixed:
-
-* **data/owncloud.log** (important!)
-* ownCloud version
-* News version
-* Browser and version
-* PHP version
-* Distribution
+Please read the [appropriate section in the contributing notices](https://github.com/owncloud/news/blob/master/CONTRIBUTING.md#bugs)
 
 ## Installation/Update
 
diff --git a/js/README.md b/js/README.md
index 1842707a3..c03621fdc 100644
--- a/js/README.md
+++ b/js/README.md
@@ -1,5 +1,5 @@
 # JavaScript && CSS Development
-Before starting, install nodejs 0.10 and grunt-cli:
+Before starting, install nodejs and grunt-cli:
 
 	sudo npm -g install grunt-cli
 
@@ -9,11 +9,11 @@ then run:
 
 
 ## Building
-Watch mode:
+This sets up a watcher on file change and compiles CSS and JS:
 
 	grunt dev
 
-Single run mode:
+If you don't want a watcher, just run:
 
 	grunt