bf344cd302
* 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 <fransdejonge@gmail.com> * fix word choice better reflect age of project Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * grammar fixes Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * remove double headings Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * 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 <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2.9 KiB
Report a bug
Have you found a bug? Don't panic, here are some steps to report it with ease:
- Search for it on the bug tracker (don't forget to use the search bar).
- If you find a similar bug, don't hesitate to post a comment to add more importance to the related ticket.
- If you didn't find it, open a new ticket.
If you have to create a new ticket, please try to keep in mind the following advice:
- Give an explicit title to the ticket so it will be easier to find it later.
- Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug?
We also need some information:
- Your FreshRSS version (on the about page or in the
constants.phpfile) - Your server configuration: the type of hosting and the PHP version
- Your storage system (SQLite, MySQL, MariaDB, PostgreSQL)
- If possible, the related logs (PHP logs and FreshRSS logs under
data/users/your_user/log.txt)
For a more detailed guide on writing bug reports, please refer to the in-depth guide on reporting bugs.
Fix a bug
Would you like to fix a bug? For optimum coordination between collaborators, you should follow these indications:
- Be sure the bug is associated with a ticket and indicate that you'll work on it.
- Fork the project repository.
- Create a new branch. The name of the branch should be clear, and ideally prefixed by the related ticket id. For instance,
783-contributing-fileto fix ticket #783. - Make your changes to your fork and send a pull request.
If you have to write code, please follow our coding style recommendations.
Tip: if you're searching for easy-to-fix bugs, please have a look at the "good first issue" ticket label.
Submit an idea
You have great ideas, yes! Don't be shy and open a new ticket on our bug tracker to ask if we can implement it. The greatest ideas often come from the shyest suggestions!
If your idea is nice, we'll have a look at it.
Contribute to internationalization (i18n)
Learn how to contribute to translations in the dedicated documentation.
Contribute to documentation
The documentation needs a lot of improvements in order to be more useful to new contributors and we are working on it. If you want to give some help, meet us in the main repositories docs directory!