summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBernhard Posselt <dev@bernhard-posselt.com>2016-07-23 22:02:21 +0200
committerBernhard Posselt <dev@bernhard-posselt.com>2016-07-23 22:02:21 +0200
commit38e657a5d5791919937ca8e0deb2460aaa103883 (patch)
tree9ed2ac42065fe483606d3236cf0c4ad1c1077935 /CONTRIBUTING.md
parentcb8f28b4d0b005d3e915b6d027683084739df3bb (diff)
removing owncloud references and updating links
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md83
1 files changed, 12 insertions, 71 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8140046e5..f0cd60db9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -20,10 +20,10 @@ This section is split into two section:
* Get the latest version of the News app
* Disable all browser add-ons to make sure that it's not a plugin's fault (adblockers!)
* 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)
+* [Check if they have already been reported](https://github.com/nextcloud/news/issues?state=open)
+* [Check if your problem is covered in the FAQ section](https://github.com/nextcloud/news#faq)
-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),
+If you are not able to add a feed because its XML *does not validate* (see [this issue](https://github.com/nextcloud/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/)
@@ -33,7 +33,7 @@ check if:
### When reporting bugs
* Enable debug mode in your **config/config.php**:
- * ownCloud >=8.2: Add the **debug** attribute to config array (if not already present) and set it to **true**:
+ * Add the **debug** attribute to config array (if not already present) and set it to **true**:
```php
<?php
$CONFIG = array(
@@ -42,14 +42,6 @@ check if:
'debug' => true,
);
```
- * ownCloud < 8.2: Add **DEFINE('DEBUG', true);** at the end of the file
- ```php
- <?php
- $CONFIG = array(
- // options
- );
- DEFINE('DEBUG', true);
- ```
* Reproduce the Problem
* Check **data/owncloud.log**
@@ -58,7 +50,7 @@ check if:
Please provide the following details so that your problem can be fixed:
* **data/owncloud.log** (important!)
-* ownCloud version
+* Nextcloud version
* News version
* Browser and version
* PHP version
@@ -79,17 +71,17 @@ is much more helpful than just writing:
For translations in other languages than English, we rely on the [Transifex](https://www.transifex.com/) platform.
-If you want to help with translating the app, please do not create a pull request. Instead, head over to https://www.transifex.com/projects/p/owncloud/resource/news/ and join the team of your native language.
+If you want to help with translating the app, please do not create a pull request. Instead, head over to https://www.transifex.com/projects/p/nextcloud/resource/news/ and join the team of your native language.
If approved, the translation will be automatically ported to the code within 24 hours.
## Explore feeds section
-You can help to improve our explore feeds section by [providing more feeds](https://github.com/owncloud/news/wiki/Explore-Feed-Section)
+You can help to improve our explore feeds section by [providing more feeds](https://github.com/nextcloud/news/tree/master/docs/explore)
## Fulltext configurations
-ownCloud News uses [picoFeed web scrapers](https://github.com/fguillot/picoFeed/blob/master/docs/grabber.markdown). Simply create a new configuration file if needed and open a pull request on their repository. The News app syncs regularely with the most recent changes.
+Nextcloud News uses [picoFeed web scrapers](https://github.com/fguillot/picoFeed/blob/master/docs/grabber.markdown). Simply create a new configuration file if needed and open a pull request on their repository. The News app syncs regularly with the most recent changes.
## Development
@@ -99,11 +91,11 @@ That way we can talk about the problem first and discuss the implementation (and
### How to set up a development environment
-To get started after [cloning the repository](https://github.com/owncloud/news#installing-from-git-development-version), install the [build dependencies](https://github.com/owncloud/news#development-dependencies) and run:
+To get started after [cloning the repository](https://github.com/nextcloud/news#installing-from-git-development-version), install the [build dependencies](https://github.com/nextcloud/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)
+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/nextcloud/news/blob/master/js/README.md)
For running all tests suites you can run:
@@ -115,15 +107,10 @@ Packaging is done via:
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.
-
### Contact Us!
-We usually hang out on **irc.freenode.net** in the **#owncloud-news** and **#owncloud-dev** chat room. Just ping [BernhardPosselt](https://github.com/BernhardPosselt/) or [cosenal](https://github.com/cosenal) or write us a mail directly. Mail addresses are listed on our GitHub profiles.
+We usually hang out on **irc.freenode.net** in the **#nextcloud-news** and **#nextcloud-dev** chat room. Just ping [BernhardPosselt](https://github.com/BernhardPosselt/) or [cosenal](https://github.com/cosenal) or write us a mail directly. Mail addresses are listed on our GitHub profiles.
-You can also send a mail to the [owncloud-devel mailing list](https://mailman.owncloud.org/mailman/listinfo/devel).
### Coding Style Guidelines
@@ -139,51 +126,5 @@ You can also send a mail to the [owncloud-devel mailing list](https://mailman.ow
* Place a space before and after the parameter block for if, else, for, foreach, function
* Everything should be in pascalCase except classes which should be in CamelCase
-* For linting JavaScript, a [jshint file](https://github.com/owncloud/news/blob/master/js/.jshintrc) is used that is run before compiling the JavaScript
-
-### Project Structure
-The project is structured in the following way:
-
-* **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
-
-* **bin/**: Git hooks and the custom Python updater
-
-* **build/**: The folder where complete archives are saved when running make appstore
-
-* **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. The database schema is stored in **appinfo/database.xml**
-
-* **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
-
-* **upgrade/**: Migrations and hooks that are run when upgrading the app to a newer version
-
-* **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
+* For linting JavaScript, a [jshint file](https://github.com/nextcloud/news/blob/master/js/.jshintrc) is used that is run before compiling the JavaScript
-* **vendor/**: 3rdparty libraries that are managed using composer.