From bf344cd30230edbb06fbdaa482a86d3592dc4aa0 Mon Sep 17 00:00:00 2001 From: ldv8434 <65482502+ldv8434@users.noreply.github.com> Date: Sun, 10 Jan 2021 14:50:54 -0500 Subject: Update and add to documentation (#3348) * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * re-fix link * remove mention of defunct mailing list * grammar fix * replace stream with feed * add optional items, replace stream with feed * replace stream with feed * fix word choice Co-authored-by: Frans de Jonge * fix word choice better reflect age of project Co-authored-by: Frans de Jonge * grammar fixes Co-authored-by: Frans de Jonge * remove double headings Co-authored-by: Frans de Jonge * change single quote to double quote for consistency * add subreddit link * change php module list to Dockerfile link * fix link to developer index, change html links to md for consistency * update css selector terms Co-authored-by: Frans de Jonge Co-authored-by: Frans de Jonge --- docs/en/developers/01_First_steps.md | 234 --------------------- docs/en/developers/01_Index.md | 29 +++ docs/en/developers/02_First_steps.md | 234 +++++++++++++++++++++ docs/en/developers/02_Github.md | 67 ------ .../en/developers/03_Backend/01_Database_schema.md | 1 + .../developers/03_Backend/03_External_libraries.md | 1 + docs/en/developers/06_Fever_API.md | 110 ++++++++++ docs/en/developers/06_Reporting_Bugs.md | 66 ++++++ 8 files changed, 441 insertions(+), 301 deletions(-) delete mode 100644 docs/en/developers/01_First_steps.md create mode 100644 docs/en/developers/01_Index.md create mode 100644 docs/en/developers/02_First_steps.md create mode 100644 docs/en/developers/06_Fever_API.md create mode 100644 docs/en/developers/06_Reporting_Bugs.md (limited to 'docs/en/developers') diff --git a/docs/en/developers/01_First_steps.md b/docs/en/developers/01_First_steps.md deleted file mode 100644 index 7b3a4c11f..000000000 --- a/docs/en/developers/01_First_steps.md +++ /dev/null @@ -1,234 +0,0 @@ -# Environment configuration (Docker) - -FreshRSS is built with PHP and uses a homemade framework, Minz. The dependencies are directly included in the source code, so you don't need Composer. - -There are various ways to configure your development environment. The easiest and most supported method is based on Docker, which is the solution documented below. If you already have a working PHP environment, you probably don't need it. - -We assume here that you use a GNU/Linux distribution, capable of running Docker. Otherwise, you'll have to adapt the commands accordingly. - -The commands that follow have to be executed in a console. They start by `$` when commands need to be executed as normal user, and by `#` when they need to be executed as root user. You don't have to type these characters. A path may be indicated before these characters to help you identify where they need to be executed. For instance, `app$ echo 'Hello World'` indicates that you have to execute `echo` command in the `app/` directory. - -First, you need to install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/). - -Once you're done, clone the repository with: - -```console -$ git clone https://github.com/FreshRSS/FreshRSS.git -$ cd FreshRSS -``` - -Note that, if you want to contribute, you have to fork the repository first and clone your fork instead of the "root" one. Adapt the commands in consequence. - -Then, the only command you need to know is the following: - -```console -$ make start -``` - -This might take some time while Docker downloads the image. If your user isn't in the `docker` group, you'll need to prepend the command with `sudo`. - -**You can now access FreshRSS at [http://localhost:8080](http://localhost:8080).** Just follow the install process and select the SQLite database. - -You can stop the containers by typing Control + c or with the following command, in another terminal: - -```console -$ make stop -``` - -If you're interested in the configuration, the `make` commands are defined in the [`Makefile`](/Makefile). - -If you need to use a different tag image (default is `alpine`), you can set the `TAG` environment variable: - -```console -$ TAG=arm make start -``` - -You can find the full list of available tags [on the Docker hub](https://hub.docker.com/r/freshrss/freshrss/tags). - -If you want to build the Docker image yourself, you can use the following command: - -```console -$ make build -$ # or -$ TAG=arm make build -``` - -The `TAG` variable can be anything (e.g. `local`). You can target a specific architecture by adding `-alpine` or `-arm` at the end of the tag (e.g. `local-arm`). - -# Project architecture - -- the PHP framework: [Minz](Minz/index.md) - -# Extensions - -If you want to create your own FreshRSS extension, take a look at the [extension documentation](03_Backend/05_Extensions.md). - -# Coding style - -If you want to contribute to the source code, it's important to follow the project's coding style. The actual code doesn't always follow it throughout the project, but we should fix it every time an opportunity presents itself. - -Contributions which don't follow the coding style will be rejected as long as the coding style is not fixed. - -## Spaces, tabs and other whitespace characters - -### Indentation -Code indentation must use tabs. - -### Alignment - -Once the code has been correctly indented, it might be useful to align it for ease of reading. In that case, please use spaces. - -```php -$result = a_function_with_a_really_long_name($param1, $param2, - $param3, $param4); -``` - -### End of line - -The newline character must be a line feed (LF), which is the default line ending on *NIX systems. This character must not follow other white space. - -You can verify if there is any unintended white space at the end of line with the following Git command: - -```bash -# command to check files before adding them in the Git index -git diff --check -# command to check files after adding them in the Git index -git diff --check --cached -``` - -### End of file - -Every file must end by an empty line. - -### Commas, dots and semi-columns - -There should no space before those characters, but there should be one after. - -### Operators - -There should be a space before and after every operator. - -```php -if ($a == 10) { - // do something -} - -echo $a ? 1 : 0; -``` - -### Parentheses - -There should be no spaces in between brackets. There should be no spaces before the opening bracket, except if it's after a keyword. There shouldn't be any spaces after the closing bracket, except if it's followed by a curly bracket. - -```php -if ($a == 10) { - // do something -} - -if ((int)$a == 10) { - // do something -} -``` - -### With chained functions - -It happens most of the time in Javascript files. When there are chained functions with closures and callback functions, it's hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level. - -```javascript -// First instruction -shortcut.add(shortcuts.mark_read, function () { - //... - }, { - 'disable_in_input': true - }); -// Second instruction -shortcut.add("shift+" + shortcuts.mark_read, function () { - //... - }, { - 'disable_in_input': true - }); -``` - -## Line length - -Lines should strive to be shorter than 80 characters. However, this limit may be extended to 100 characters when strictly necessary. - -With functions, parameters can be declared on multiple lines. - -```php -function my_function($param_1, $param_2, - $param_3, $param_4) { - // do something -} -``` - -## Naming - -All code elements (functions, classes, methods and variables) must describe their usage succinctly. - -### Functions and variables - -Functions and variables must follow the "snake case" naming convention. - -```php -// a function -function function_name() { - // do something -} -// a variable -$variable_name; -``` - -### Methods - -Methods must follow the "lower camel case" naming convention. - -```php -private function methodName() { - // do something -} -``` - -### Classes - -Classes must follow the "upper camel case" naming convention. - -```php -abstract class ClassName {} -``` - -## Encoding - -Files must be encoded with the UTF-8 character set. - -## PHP compatibility - -Please ensure that your code works with the oldest PHP version officially supported by FreshRSS. - -## Miscellaneous - -### Operators -Operators must be at the end of the line if a condition is split over more than one line. - -```php -if ($a == 10 || - $a == 20) { - // do something -} -``` - -### End of file - -If the file contains only PHP code, the PHP closing tag must be omitted. - -### Arrays - -If an array declaration runs on more than one line, each element must be followed by a comma, including the last one. - -```php -$variable = [ - "value 1", - "value 2", - "value 3", -]; -``` diff --git a/docs/en/developers/01_Index.md b/docs/en/developers/01_Index.md new file mode 100644 index 000000000..fcd9204af --- /dev/null +++ b/docs/en/developers/01_Index.md @@ -0,0 +1,29 @@ +# FreshRSS Development + +## First Steps + +Start by creating your development environment. A guide to setting up FreshRSS's development environment can be found on [the appropriate page](02_First_steps.md). + +## After That + +* [Github Branching and Pushing](02_Github.md) +* [Running tests](03_Running_tests.md) +* [Creating a pull request](04_Pull_requests.md) +* [Releasing a new version](05_Release_new_version.md) +* [Reporting bugs](06_Reporting_Bugs.md) +* [Fever API](06_Fever_API.md) + +## Backend Development + +* [Making extensions for FreshRSS](03_Backend/05_Extensions.md) +* [Database Schema](03_Backend/01_Database_schema.md) +* [External libraries](03_Backend/03_External_libraries.md) +* [Changing source code](03_Backend/04_Changing_source_code.md) + +## Frontend Development + +* [View files](04_Frontend/01_View_files.md) +* [Design](04_Frontend/02_Design.md) + +## Minz +Minz is the homemade PHP framework used by FreshRSS. More information can be found [here](Minz/index.md). \ No newline at end of file diff --git a/docs/en/developers/02_First_steps.md b/docs/en/developers/02_First_steps.md new file mode 100644 index 000000000..7b3a4c11f --- /dev/null +++ b/docs/en/developers/02_First_steps.md @@ -0,0 +1,234 @@ +# Environment configuration (Docker) + +FreshRSS is built with PHP and uses a homemade framework, Minz. The dependencies are directly included in the source code, so you don't need Composer. + +There are various ways to configure your development environment. The easiest and most supported method is based on Docker, which is the solution documented below. If you already have a working PHP environment, you probably don't need it. + +We assume here that you use a GNU/Linux distribution, capable of running Docker. Otherwise, you'll have to adapt the commands accordingly. + +The commands that follow have to be executed in a console. They start by `$` when commands need to be executed as normal user, and by `#` when they need to be executed as root user. You don't have to type these characters. A path may be indicated before these characters to help you identify where they need to be executed. For instance, `app$ echo 'Hello World'` indicates that you have to execute `echo` command in the `app/` directory. + +First, you need to install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/). + +Once you're done, clone the repository with: + +```console +$ git clone https://github.com/FreshRSS/FreshRSS.git +$ cd FreshRSS +``` + +Note that, if you want to contribute, you have to fork the repository first and clone your fork instead of the "root" one. Adapt the commands in consequence. + +Then, the only command you need to know is the following: + +```console +$ make start +``` + +This might take some time while Docker downloads the image. If your user isn't in the `docker` group, you'll need to prepend the command with `sudo`. + +**You can now access FreshRSS at [http://localhost:8080](http://localhost:8080).** Just follow the install process and select the SQLite database. + +You can stop the containers by typing Control + c or with the following command, in another terminal: + +```console +$ make stop +``` + +If you're interested in the configuration, the `make` commands are defined in the [`Makefile`](/Makefile). + +If you need to use a different tag image (default is `alpine`), you can set the `TAG` environment variable: + +```console +$ TAG=arm make start +``` + +You can find the full list of available tags [on the Docker hub](https://hub.docker.com/r/freshrss/freshrss/tags). + +If you want to build the Docker image yourself, you can use the following command: + +```console +$ make build +$ # or +$ TAG=arm make build +``` + +The `TAG` variable can be anything (e.g. `local`). You can target a specific architecture by adding `-alpine` or `-arm` at the end of the tag (e.g. `local-arm`). + +# Project architecture + +- the PHP framework: [Minz](Minz/index.md) + +# Extensions + +If you want to create your own FreshRSS extension, take a look at the [extension documentation](03_Backend/05_Extensions.md). + +# Coding style + +If you want to contribute to the source code, it's important to follow the project's coding style. The actual code doesn't always follow it throughout the project, but we should fix it every time an opportunity presents itself. + +Contributions which don't follow the coding style will be rejected as long as the coding style is not fixed. + +## Spaces, tabs and other whitespace characters + +### Indentation +Code indentation must use tabs. + +### Alignment + +Once the code has been correctly indented, it might be useful to align it for ease of reading. In that case, please use spaces. + +```php +$result = a_function_with_a_really_long_name($param1, $param2, + $param3, $param4); +``` + +### End of line + +The newline character must be a line feed (LF), which is the default line ending on *NIX systems. This character must not follow other white space. + +You can verify if there is any unintended white space at the end of line with the following Git command: + +```bash +# command to check files before adding them in the Git index +git diff --check +# command to check files after adding them in the Git index +git diff --check --cached +``` + +### End of file + +Every file must end by an empty line. + +### Commas, dots and semi-columns + +There should no space before those characters, but there should be one after. + +### Operators + +There should be a space before and after every operator. + +```php +if ($a == 10) { + // do something +} + +echo $a ? 1 : 0; +``` + +### Parentheses + +There should be no spaces in between brackets. There should be no spaces before the opening bracket, except if it's after a keyword. There shouldn't be any spaces after the closing bracket, except if it's followed by a curly bracket. + +```php +if ($a == 10) { + // do something +} + +if ((int)$a == 10) { + // do something +} +``` + +### With chained functions + +It happens most of the time in Javascript files. When there are chained functions with closures and callback functions, it's hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level. + +```javascript +// First instruction +shortcut.add(shortcuts.mark_read, function () { + //... + }, { + 'disable_in_input': true + }); +// Second instruction +shortcut.add("shift+" + shortcuts.mark_read, function () { + //... + }, { + 'disable_in_input': true + }); +``` + +## Line length + +Lines should strive to be shorter than 80 characters. However, this limit may be extended to 100 characters when strictly necessary. + +With functions, parameters can be declared on multiple lines. + +```php +function my_function($param_1, $param_2, + $param_3, $param_4) { + // do something +} +``` + +## Naming + +All code elements (functions, classes, methods and variables) must describe their usage succinctly. + +### Functions and variables + +Functions and variables must follow the "snake case" naming convention. + +```php +// a function +function function_name() { + // do something +} +// a variable +$variable_name; +``` + +### Methods + +Methods must follow the "lower camel case" naming convention. + +```php +private function methodName() { + // do something +} +``` + +### Classes + +Classes must follow the "upper camel case" naming convention. + +```php +abstract class ClassName {} +``` + +## Encoding + +Files must be encoded with the UTF-8 character set. + +## PHP compatibility + +Please ensure that your code works with the oldest PHP version officially supported by FreshRSS. + +## Miscellaneous + +### Operators +Operators must be at the end of the line if a condition is split over more than one line. + +```php +if ($a == 10 || + $a == 20) { + // do something +} +``` + +### End of file + +If the file contains only PHP code, the PHP closing tag must be omitted. + +### Arrays + +If an array declaration runs on more than one line, each element must be followed by a comma, including the last one. + +```php +$variable = [ + "value 1", + "value 2", + "value 3", +]; +``` diff --git a/docs/en/developers/02_Github.md b/docs/en/developers/02_Github.md index a898dc23e..953785d4f 100644 --- a/docs/en/developers/02_Github.md +++ b/docs/en/developers/02_Github.md @@ -1,70 +1,3 @@ -# Reporting a bug or a suggestion - -Despite the care given to FreshRSS, it's still possible that bugs occur. The project is young and development is dynamic, so it can be corrected quickly. You might also have a feature in mind that doesn't yet exist. Regardless whether your idea seems silly, far-fetched, useless or too specific, please don't hesitate to propose it to us! "Ideas in the air" often find an attentive ear. It's new external perspectives that make the project evolve the most. - -If you're convinced that you should be heard, here's how you can go about it. - -## On GitHub - -GitHub is the ideal platform to submit your requests. It allows us to discuss a problem or suggestion with others and it often generates new ideas. Let's not neglect this "social" aspect! - - 1. [Go to the bug ticket manager](https://github.com/FreshRSS/FreshRSS/issues) - 2. Start by checking if a similar request hasn't already been made. If so, please feel free to add your voice to the request. - 3. If your request is new, [open a new bug ticket](https://github.com/FreshRSS/FreshRSS/issues/new) - 4. Finally, write your request. If you're fluent in English, it's the preferred language because it allows for discussion with the largest number of people. - 5. Please follow the tips below to make it easier to let your ticket be heard. - -## Informal - -Not everyone likes or uses GitHub for a variety of legitimate reasons. That is why you can also contact us in a more informal way. - -* On [our Mattermost chat](https://framateam.org/signup_user_complete/?id=e2680d3e3128b9fac8fdb3003b0024ee) -* On [the mailing lists](https://freshrss.org/announce-of-the-mailing-lists.html) -* At events / meetings around Free Software -* Over a beer in a bar -* Etc. - -## Tips - -Here are some tips to help you present your bug report or suggestion: - - -* **Pay attention to spelling**. Even if it's not always easy, try your best! -* **Give an explicit title to your request**, even if it's a bit long. This not only helps us understand your request, but also to find your ticket later. -* **One request = one ticket.** You may have lots of ideas while being afraid to spam the bug manager: it doesn't matter. It's better to have a few too many tickets than too many requests in one. We'll close and consolidate requests when possible. -* If you report a bug, think about **providing us with the FreshRSS logs** (accessible in the FreshRSS `data/log/` folder) and the **PHP logs** (the location may vary by distribution, but consider searching in `/var/log/httpd` or `/var/log/apache`). -* If you can't find the log files, specify it in your ticket so we know you've already searched. -* Not all bugs require logs, but if you have any doubts, it is better to provide them to us. Logs are important and very useful for debugging! -* The logs may reveal confidential information, so **be careful not to disclose anything sensitive.** - -In addition, when facing a bug, you're encouraged to follow this message format (from the [Sam & Max website](http://sametmax.com/template-de-demande-daide-en-informatique/): - -### What's my goal? - -Give the general context of what you were trying to do. - -### What have I been trying to do? - -Explain step by step what you have done so that we can reproduce the bug. - -### What results have I achieved? - -The bug: what you see that shouldn't have happened. Here you can provide the logs. - -### What was the expected result? - -So that we understand what you consider to be the problem. - -### What are my circumstances? - -Remember to give the following information if you know it: - - 1. Which browser? Which version? - 2. Which server: Apache, Nginx? Which version? - 3. Which version of PHP? - 4. Which database: SQLite, MySQL, MariaDB, PostgreSQL? Which version? - 5. Which distribution runs on the server? And... which version? - # Branching ## Basic diff --git a/docs/en/developers/03_Backend/01_Database_schema.md b/docs/en/developers/03_Backend/01_Database_schema.md index e69de29bb..1978eabea 100644 --- a/docs/en/developers/03_Backend/01_Database_schema.md +++ b/docs/en/developers/03_Backend/01_Database_schema.md @@ -0,0 +1 @@ +# Database Schema \ No newline at end of file diff --git a/docs/en/developers/03_Backend/03_External_libraries.md b/docs/en/developers/03_Backend/03_External_libraries.md index e69de29bb..2f6ca8efb 100644 --- a/docs/en/developers/03_Backend/03_External_libraries.md +++ b/docs/en/developers/03_Backend/03_External_libraries.md @@ -0,0 +1 @@ +# External Libraries diff --git a/docs/en/developers/06_Fever_API.md b/docs/en/developers/06_Fever_API.md new file mode 100644 index 000000000..0a0da90a5 --- /dev/null +++ b/docs/en/developers/06_Fever_API.md @@ -0,0 +1,110 @@ +# FreshRSS - Fever API implementation + +See the [page about our Google Reader compatible API](06_Mobile_access.md) for another possibility +and general aspects of API access. + +## RSS clients + +There are many RSS clients that support the Fever API, but they seem to understand the Fever API a bit differently. +If your favourite client doesn't work properly with this API, please create an issue and we'll have a look. +But we can **only** do that for free clients. + +### Usage & Authentication + +Before you can start using this API, you have to enable and setup API access, which is [documented here](https://freshrss.github.io/FreshRSS/en/users/06_Mobile_access.html), +and then reset the user’s API password. + +Then point your mobile application to the `fever.php` address (e.g. `https://freshrss.example.net/api/fever.php`). + +## Compatible clients + +| App | Platform | License | +|:----------------------------------------------------------------------------------:|:-------------------:|:--------------------------------------------------------:| +|[Fluent Reader](https://hyliu.me/fluent-reader/) |Windows, Linux, macOS|[BSD-3-Clause](https://github.com/yang991178/fluent-reader/blob/master/LICENSE)| +|[Readably](https://play.google.com/store/apps/details?id=com.isaiasmatewos.readably)|Android |Closed Source | +|[Fiery Feeds](https://apps.apple.com/app/fiery-feeds-rss-reader/id1158763303) |iOS |Closed Source | +|[Unread](https://apps.apple.com/app/unread-rss-reader/id1252376153) |iOS |Closed Source | +|[Reeder](https://www.reederapp.com/) |iOS |Closed Source | +|[ReadKit](https://apps.apple.com/app/readkit/id588726889) |macOS |Closed Source | + +## Features + +The following features are implemented: + +* fetching categories +* fetching feeds +* fetching RSS items (new, favorites, unread, by_id, by_feed, by_category, since) +* fetching favicons +* setting read marker for item(s) +* setting starred marker for item(s) +* setting read marker for feed +* setting read marker for category +* supports FreshRSS extensions, which use the `entry_before_display` hook + +The following features are not supported: + +* **Hot Links** aka **hot** as there is nothing in FreshRSS yet that is similar or could be used to simulate it. + +## Testing and debugging + +If this API does not work as expected in your RSS reader, you can test it manually with a tool like [Postman](https://www.getpostman.com/). + +Configure a POST request to the URL https://freshrss.example.net/api/fever.php?api which should give you the result: +```json +{ + "api_version": 3, + "auth": 0 +} +``` +Great, the base setup seems to work! + +Now lets try an authenticated call. Fever uses an `api_key`, which is the MD5 hash of `"$username:$apiPassword"`. +Assuming the user is `kevin` and the password `freshrss`, here is a command-line example to compute the resulting `api_key` + +```sh +api_key=`echo -n "kevin:freshrss" | md5sum | cut -d' ' -f1` +``` + +Add a body to your POST request encoded as `form-data` and one key named `api_key` with the value `your-password-hash`: + +```sh +curl -s -F "api_key=$api_key" 'https://freshrss.example.net/api/fever.php?api' +``` + +This should give: +```json +{ + "api_version": 3, + "auth": 1, + "last_refreshed_on_time": "1520013061" +} +``` +Perfect, you're now authenticated and you can start testing the more advanced features. To do so, change the URL and append the possible API actions to your request parameters. Please refer to the [original Fever documentation](https://feedafever.com/api) for more information. + +Some basic calls are: + +* https://freshrss.example.net/api/fever.php?api&items +* https://freshrss.example.net/api/fever.php?api&feeds +* https://freshrss.example.net/api/fever.php?api&groups +* https://freshrss.example.net/api/fever.php?api&unread_item_ids +* https://freshrss.example.net/api/fever.php?api&saved_item_ids +* https://freshrss.example.net/api/fever.php?api&items&since_id=some_id +* https://freshrss.example.net/api/fever.php?api&items&max_id=some_id +* https://freshrss.example.net/api/fever.php?api&mark=item&as=read&id=some_id +* https://freshrss.example.net/api/fever.php?api&mark=item&as=unread&id=some_id + +Replace `some_id` with a real ID from your `freshrss_username_entry` database. + +### Debugging + +If nothing helps and your client is still misbehaving, you can add the following lines to the beginning of the `fever.api` file to determine the cause of the problems: + +```php +file_put_contents(__DIR__ . '/fever.log', $_SERVER['HTTP_USER_AGENT'] . ': ' . json_encode($_REQUEST) . PHP_EOL, FILE_APPEND); +``` + +Then use your RSS client to query the API and afterwards check the file `fever.log`. + +## Credits + +This plugin was inspired by the [tinytinyrss-fever-plugin](https://github.com/dasmurphy/tinytinyrss-fever-plugin). diff --git a/docs/en/developers/06_Reporting_Bugs.md b/docs/en/developers/06_Reporting_Bugs.md new file mode 100644 index 000000000..12d3259a6 --- /dev/null +++ b/docs/en/developers/06_Reporting_Bugs.md @@ -0,0 +1,66 @@ +# Reporting a bug or a suggestion + +Despite the care given to FreshRSS, it's still possible that bugs occur. Development is dynamic, so issues can be corrected quickly. You might also have a feature in mind that doesn't yet exist. Regardless whether your idea seems silly, far-fetched, useless or too specific, please don't hesitate to propose it to us! "Ideas in the air" often find an attentive ear. It's new external perspectives that make the project evolve the most. + +If you're convinced that you should be heard, here's how you can go about it. + +## On GitHub + +GitHub is the ideal platform to submit your requests. It allows us to discuss a problem or suggestion with others and it often generates new ideas. Let's not neglect this "social" aspect! + + 1. [Go to the bug ticket manager](https://github.com/FreshRSS/FreshRSS/issues) + 2. Start by checking if a similar request hasn't already been made. If so, please feel free to add your voice to the request. + 3. If your request is new, [open a new bug ticket](https://github.com/FreshRSS/FreshRSS/issues/new) + 4. Finally, write your request. If you're fluent in English, it's the preferred language because it allows for discussion with the largest number of people. + 5. Please follow the tips below to make it easier to let your ticket be heard. + +## Informal + +Not everyone likes or uses GitHub for a variety of legitimate reasons. That is why you can also contact us in a more informal way. + +* On [our Mattermost chat](https://framateam.org/signup_user_complete/?id=e2680d3e3128b9fac8fdb3003b0024ee) +* On [our subreddit](https://www.reddit.com/r/freshrss/) +* At events / meetings around Free Software +* Over a beer in a bar +* Etc. + +## Tips + +Here are some tips to help you present your bug report or suggestion: + + +* **Pay attention to spelling**. Even if it's not always easy, try your best! +* **Give an explicit title to your request**, even if it's a bit long. This not only helps us understand your request, but also to find your ticket later. +* **One request = one ticket.** You may have lots of ideas while being afraid to spam the bug manager: it doesn't matter. It's better to have a few too many tickets than too many requests in one. We'll close and consolidate requests when possible. +* If you report a bug, think about **providing us with the FreshRSS logs** (accessible in the FreshRSS `data/log/` folder) and the **PHP logs** (the location may vary by distribution, but consider searching in `/var/log/httpd` or `/var/log/apache`). +* If you can't find the log files, specify it in your ticket so we know you've already searched. +* Not all bugs require logs, but if you have any doubts, it is better to provide them to us. Logs are important and very useful for debugging! +* The logs may reveal confidential information, so **be careful not to disclose anything sensitive.** + +In addition, when facing a bug, you're encouraged to follow this message format (from the [Sam & Max website](http://sametmax.com/template-de-demande-daide-en-informatique/): + +### What's my goal? + +Give the general context of what you were trying to do. + +### What have I been trying to do? + +Explain step by step what you have done so that we can reproduce the bug. + +### What results have I achieved? + +The bug: what you see that shouldn't have happened. Here you can provide the logs. + +### What was the expected result? + +So that we understand what you consider to be the problem. + +### What are my circumstances? + +Remember to give the following information if you know it: + + 1. Which browser? Which version? + 2. Which server: Apache, Nginx? Which version? + 3. Which version of PHP? + 4. Which database: SQLite, MySQL, MariaDB, PostgreSQL? Which version? + 5. Which distribution runs on the server? And... which version? -- cgit v1.2.3