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/contributing.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) (limited to 'docs/en/contributing.md') diff --git a/docs/en/contributing.md b/docs/en/contributing.md index 3d4bde6a8..91fc49797 100644 --- a/docs/en/contributing.md +++ b/docs/en/contributing.md @@ -1,10 +1,3 @@ -## Join us on the mailing lists - -Do you want to ask us some questions? Do you want to discuss with us? Don't hesitate to subscribe to our mailing lists! - -* The first mailing is destined to generic information, it should be adapted to users. [Join mailing@freshrss.org](https://freshrss.org/mailman/listinfo/mailing). -* The second mailing is mainly for developers. [Join dev@freshrss.org](https://freshrss.org/mailman/listinfo/dev) - ## Report a bug Have you found a bug? Don't panic, here are some steps to report it with ease: @@ -25,6 +18,8 @@ We also need some information: * 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](developers/06_Reporting_Bugs). + ## Fix a bug Would you like to fix a bug? For optimum coordination between collaborators, you should follow these indications: @@ -34,7 +29,7 @@ Would you like to fix a bug? For optimum coordination between collaborators, you 3. [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). The name of the branch should be clear, and ideally prefixed by the related ticket id. For instance, `783-contributing-file` to fix [ticket #783](https://github.com/FreshRSS/FreshRSS/issues/783). 4. Make your changes to your fork and [send a pull request](https://help.github.com/articles/using-pull-requests/). -If you have to write code, please follow [our coding style recommendations](developers/01_First_steps.md). +If you have to write code, please follow [our coding style recommendations](developers/02_First_steps.md). **Tip:** if you're searching for easy-to-fix bugs, please have a look at the "[good first issue](https://github.com/FreshRSS/FreshRSS/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)" ticket label. -- cgit v1.2.3