chylex/Nextcloud-News
1
0
Fork 0
mirror of https://github.com/chylex/Nextcloud-News.git synced 2025-04-16 04:15:42 +02:00
Code

Fix references to old manual versions and general cleanup ()

Browse Source
This commit is contained in:
Sean Molenaar 2019-03-06 17:04:52 +01:00 committed by Benjamin Brahmer
parent 9f4ebfd8ee
commit da0872c5ca
6 changed files with 9 additions and 44 deletions

34
CONTRIBUTING.md
View File

@ -3,23 +3,14 @@ Read this when you want to:
* [file an issue (bug or feature request)](#Issues)
* [help translate the News file to your language](#Translation)
* start programming and change the way the News app works
* add cool new feeds to the feed explore section
* want to provide additional full text feed rules
* [start programming and change the way the News app works](#development)
* [add cool new feeds to the feed explore section](#explore-feeds-section)
## General
* Be as precise in your issues as possible and make it as easy as possible to understand.
* Follow the [code of conduct](https://nextcloud.com/code-of-conduct/). Being a dick and insulting people will get your posts deleted and issues locked.
## Issues
This section is split into two section:
* Everything that has to do with bugs
* How to request features
### 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 latest version of the News app
@ -27,16 +18,11 @@ This section is split into two section:
* 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/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/nextcloud/news/issues/133) for an example),
check if:
**For feed parsing issues, check**:
* 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 in your **config/config.php**:
* Add the **debug** attribute to config array (if not already present) and set it to **true**:
```php
@ -53,7 +39,6 @@ check if:
* Check your [browser's JavaScript console for errors](http://ggnome.com/wiki/Using_The_Browser_Error_Console) if it's a client-side issue
Please provide the following details so that your problem can be fixed:
* **data/nextcloud.log** (important!)
* Nextcloud version
* News version
@ -62,7 +47,6 @@ Please provide the following details so that your problem can be fixed:
* Distribution and version
### When Requesting Features
Please always provide the use case in addition solution, e.g.:
* "If I read feed that has comics, the newest first ordering does not work well because I have to read from the bottom up"
@ -84,18 +68,12 @@ If approved, the translation will be automatically ported to the code within 24
## Explore feeds 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
Nextcloud News uses [picoFeed web scrapers](https://github.com/miniflux/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
In general it's a good idea to **first create an issue where you explain why, what and how** you want to make a change **before writing any code**.
That way we can talk about the problem first and discuss the implementation (and of course help you with your code)
### How to set up a development environment
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
@ -112,13 +90,7 @@ Packaging is done via:
The packages are inside the top level **build/artifacts** folder
### Contact Us!
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.
### Coding Style Guidelines
The PHP code should all adhere to [PSR-2](https://www.php-fig.org/psr/psr-2/).
*Note that this is a different codestyle than nextcloud itself uses.*
To test the codestyle you can run `make phpcs`.

2
appinfo/info.xml
View File

@ -7,7 +7,7 @@
Before you update to a new version, [check the changelog](https://github.com/nextcloud/news/blob/master/CHANGELOG.md) to avoid surprises.
**Important**: To enable feed updates you will need to enable either [Nextcloud system cron](https://docs.nextcloud.com/server/10/admin_manual/configuration_server/background_jobs_configuration.html#cron) or use [an updater](https://github.com/nextcloud/news-updater) which uses the built in update API and disable cron updates. More information can be found [in the README](https://github.com/nextcloud/news).]]></description>
**Important**: To enable feed updates you will need to enable either [Nextcloud system cron](https://docs.nextcloud.org/server/latest/admin_manual/configuration_server/background_jobs_configuration.html#cron) or use [an updater](https://github.com/nextcloud/news-updater) which uses the built in update API and disable cron updates. More information can be found [in the README](https://github.com/nextcloud/news).]]></description>
<version>13.0.3</version>
<licence>agpl</licence>
<author>Bernhard Posselt</author>

5
composer.lock generated
View File

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "1630b553e70e8245b11922394d4d9f59",
"content-hash": "e252c35035e7c61a7b6cb6e27808d732",
"packages": [
{
"name": "arthurhoaro/favicon",
@ -1904,7 +1904,8 @@
"prefer-stable": false,
"prefer-lowest": false,
"platform": {
"php": "^7.0"
"php": "^7.0",
"ext-json": "*"
},
"platform-dev": []
}

2
docs/install.md
View File

@ -21,7 +21,7 @@
Before you install the app do the following:
* Check that your **nextcloud/data/** directory is owned by your web server user and that it is write/readable
* Check that your installation fulfills the [requirements listed in the README section](https://github.com/nextcloud/news#dependencies)
* [Set up Nextcloud Background Jobs](https://docs.nextcloud.com/server/10/admin_manual/configuration_server/background_jobs_configuration.html#cron) to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes.
* [Set up Nextcloud Background Jobs](https://docs.nextcloud.org/server/latest/admin_manual/configuration_server/background_jobs_configuration.html#cron) to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes.
Then proceed to install the app either from an archive (zip/tar.gz) or clone it from the repository using git

3
package-lock.json generated
View File

@ -1,3 +0,0 @@
{
"lockfileVersion": 1
}

7
tests/Unit/Fetcher/FeedFetcherTest.php
View File

@ -17,22 +17,17 @@ use FeedIo\Feed\Item\Author;
use FeedIo\Feed\Item\MediaInterface;
use FeedIo\Feed\ItemInterface;
use FeedIo\FeedInterface;
use Favicon\Favicon;
use OC\L10N\L10N;
use OCA\AdminAudit\Actions\Auth;
use \OCA\News\Db\Feed;
use \OCA\News\Db\Item;
use OCA\News\Fetcher\FeedFetcher;
use OCA\News\Utility\PicoFeedFaviconFactory;
use OCA\News\Utility\PsrLogger;
use OCA\News\Utility\Time;
use OCP\IL10N;
use PHPUnit\Framework\TestCase;
use PicoFeed\Client\Client;
use PicoFeed\Parser\Parser;
use PicoFeed\Processor\ItemPostProcessor;
use PicoFeed\Reader\Favicon;
use PicoFeed\Reader\Reader;
/**
* Class FeedFetcherTest