summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Brahmer <info@b-brahmer.de>2021-01-21 16:55:42 +0100
committerBenjamin Brahmer <info@b-brahmer.de>2021-01-21 17:49:20 +0100
commit6d71dfa849682255b059345fdbb319b885c08619 (patch)
tree57882b3512ef86038355080b9ad452f150e4056e
parentd7a8d8a13d43821affbf3de2d1225b48f48e1baf (diff)
update the contributing file
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
-rw-r--r--CONTRIBUTING.md50
1 files changed, 24 insertions, 26 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4b58cc2b9..b4b14f312 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,28 +1,34 @@
# Contributing
+
+News is developed by volunteers in their free time with some support through the Nextcloud organization and community. To keep this project alive we need contributions from volunteers, the software is provided under the [AGPL v3.0 license](https://github.com/nextcloud/news/blob/master/COPYING).
+
Read this when you want to:
-* [file an issue (bug or feature request)](#Issues)
+* [report a bug](#Issues)
* [help translate the News file to your language](#Translation)
* [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.
+* Be as precise in your issues as possible and make it as easy as possible to understand, this heavily influences the possibility to actually help you.
* 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.
+* Please follow the issue template and fill all the sections as much as you can, if not we might close your issue without any comment.
+
+### Feed issues
+**For feed parsing issues, check**:
+* It is a valid RSS by running it through the [W3C validator](http://validator.w3.org/feed/)
+* Check if [feed-io](https://feed-io.net/) can handle it.
+* Use the [feed issues](https://github.com/nextcloud/news/discussions/categories/feed-issues) section in discussions.
-### Before Reporting Bugs
+### Hints for 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
-* 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
+* Get the latest version of the News app, check the [Nextcloud App Store](https://apps.nextcloud.com/apps/news/releases).
+* Disable all browser add-ons to make sure that it's not a plugin's fault (adblockers, especially cosmetic filters)
+* Clear your PHP opcode cache if you use any by restarting your webserver.
* [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)
-**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
+### Debugging issues
* 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
@@ -38,14 +44,6 @@ Read this when you want to:
* Check **data/nextcloud.log**
* 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
-* Browser and version
-* PHP version
-* Distribution and version
-
### When Requesting Features
Please always provide the use case in addition solution, e.g.:
@@ -55,6 +53,7 @@ is much more helpful than just writing:
* "Please add reverse ordering".
+Features don't belong into the issues section, instead discuss them in [discussions](https://github.com/nextcloud/news/discussions/categories/features).
## Translation
@@ -64,15 +63,14 @@ If you want to help with translating the app, please do not create a pull reques
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/nextcloud/news/tree/master/docs/explore)
-
## Development
-You can first create a discussion where you explain why, what and how you want to make a change before writing any code. If you want to agree on a solution first.
+You can first create a [discussion](https://github.com/nextcloud/news/discussions/categories/features) where you explain why, what and how you want to make a change before writing any code. If you want to agree on a solution first.
### 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:
+To get started setup an developer [environment](https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html). Inside the apps directory clone the news repository and enable the app with occ.
+Make sure you have all [dependencies](https://github.com/nextcloud/news/blob/master/docs/install.md#build-dependencies) installed.
+
+To build the app run:
make