doc/Developers-Intro.md

   1 Where to get started to help improve Friendica?
   2 ===============================================
   3
   4 * [Home](help)
   5
   6 Do you want to help us improve Friendica?
   7 Here we have compiled some hints on how to get started and some tasks to help you choose.
   8 A project like Friendica is the sum of many different contributions.
   9 **Very different skills are required to make good software.
  10 Some of them involve coding, others do not.**
  11 We are looking for helpers in all areas, whether you write text or code, whether you spread the word to convince people or design new icons.
  12 Whether you feel like an expert or like a newbie - join us with your ideas!
  13
  14 Contact us
  15 ---
  16
  17 The discussion of Friendica development takes place in the following Friendica forums:
  18
  19 * The main [forum for Friendica development](https://helpers.pyxis.uberspace.de/profile/developers)
  20 * The [forum for Friendica theme development](https://friendica.eu/profile/ftdevs)
  21
  22 Help other users
  23 ---
  24
  25 Remember the questions you had when you first tried Friendica?
  26 A good place to start can be to help new people find their way around Friendica in the [general support forum](https://helpers.pyxis.uberspace.de/profile/helpers).
  27 Welcome them, answer their questions, point them to documentation or ping other helpers directly if you can't help but think you know who can.
  28
  29 Translation
  30 ---
  31
  32 The documentation contains help on how to translate Friendica [at Transifex](/help/translations) where the UI is translated.
  33 If you don't want to translate the UI, or it is already done to your satisfaction, you might want to work on the translation of the /help files?
  34
  35 Design
  36 ---
  37
  38 Are you good at designing things?
  39 If you have seen Friendica you probably have ideas to improve it, haven't you?
  40
  41 * If you would like to work with us on enhancing the user interface, please join the [UX Watchdogs forum](https://fc.oscp.info/profile/ux-watchdogs)
  42 * Make plans for a better Friendica interface design and share them with us.
  43 * Tell us if you are able to realize your ideas or what kind of help you need.
  44 We can't promise we have the right skills in the group but we'll try.
  45 * Choose a thing to start with, e.g. work on the icon set of your favorite theme
  46
  47 Programming
  48 ---
  49
  50 ###Coding standards
  51
  52 For the sake of consistency between contribution and general code readability, Friendica follows the widespread [PSR-2 coding standards](http://www.php-fig.org/psr/psr-2/) to the exception of a few rules.
  53 Here's a few primers if you are new to Friendica or to the PSR-2 coding standards:
  54  * Indentation is tabs, period (not PSR-2).
  55  * By default, strings are enclosed in single quotes, but feel free to use double quotes if it makes more sense (SQL queries, adding tabs and line feeds).
  56  * Operators are wrapped by spaces, e.g. `$var === true`, `$var = 1 + 2` and `'string' . $concat . 'enation'`
  57  * Braces are mandatory in conditions
  58  * No closing PHP tag
  59  * No trailing spaces
  60
  61 Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica.
  62 There are a few tools you can use to check or fix your files before you commit.
  63
  64 For documentation we use the standard of *one sentence per line* for the `md` files in the `/doc` and `/doc/$lng` subdirectories.
  65
  66 ####Check with [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer)
  67
  68 This tool checks your files against a variety of coding standards, including PSR-2, and ouputs a report of all the standard violations.
  69 You can simply install it through PEAR: `pear install PHP_CodeSniffer`
  70 Once it is installed and available in your PATH, here's the command to run before committing your work:
  71
  72         $> phpcs --standard=PSR2 <file or directory>
  73
  74 The output is a list of all the coding standards violations that you should fix before committing your work.
  75 Additionally, `phpcs` integrates with a few IDEs (Eclipse, Netbeans, PHPStorm...) so that you don't have to fiddle with the command line.
  76
  77 ####Fix with PHP Code Beautifier and Fixer (phpbcf) included in PHP Code Sniffer
  78
  79 If you're getting a massive list of standards violations when running `phpcs`, it can be annoying to fix all the violations by hand.
  80 Thankfully, PHP Code Sniffer is shipped with an automatic code fixer that can take care of the tedious task for you.
  81 Here's the command to automatically fix the files you created/modified:
  82
  83         $> phpcbf --standard=PSR2 <file or directory>
  84
  85 If the command-line tools `diff` and `patch` are unavailabe for you, `phpcbf` can use slightly slower PHP equivalents by using the `--no-patch` argument.
  86
  87 ###Code documentation
  88
  89 If you are interested in having the documentation of the Friendica code outside of the code files, you can use [Doxygen](http://doxygen.org) to generate it.
  90 The configuration file for Doxygen is located in the `util` directory of the project sources.
  91 Run
  92
  93     $> doxygen util/Doxyfile
  94
  95 to generate the files which will be located in the `doc/html` subdirectory in the Friendica directory.
  96 You can browse these files with any browser.
  97
  98 If you find missing documentation, don't hesitate to contact us and write it down to enhance the code documentation.
  99
 100 ###Issues
 101
 102 Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!
 103
 104  * Try to reproduce a bug that needs more inquiries and write down what you find out.
 105  * If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed.
 106  * Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
 107  * There is a *Junior Job* label for issues we think might be a good point to start with.
 108    But you don't have to limit yourself to those issues.
 109
 110 ###Web interface
 111
 112 The thing many people want most is a better interface, preferably a responsive Friendica theme.
 113 This is a piece of work!
 114 If you want to get involved here:
 115
 116 * Look at the first steps that were made (e.g. the clean theme).
 117 Ask us to find out whom to talk to about their experiences.
 118 * Talk to design people if you know any.
 119 * Let us know about your plans [in the dev forum](https://helpers.pyxis.uberspace.de/profile/developers) and the [theme developer forum](https://friendica.eu/profile/ftdevs).
 120 Do not worry about cross-posting.
 121
 122 ###Client software
 123 As Friendica is using a [Twitter/GNU Social compatible API](help/api) any of the clients for those platforms should work with Friendica as well.
 124 Furthermore there are several client projects, especially for use with Friendica.
 125 If you are interested in improving those clients, please contact the developers of the clients directly.
 126
 127 * Android / CynogenMod: **Friendica for Android** [src](https://github.com/max-weller/friendica-for-android), [homepage](http://friendica.android.max-weller.de/) - abandoned
 128 * iOS: *currently no client*
 129 * SailfishOS: **Friendiy** [src](https://kirgroup.com/projects/fabrixxm/harbour-friendly) - developed by [Fabio](https://kirgroup.com/profile/fabrixxm/?tab=profile)
 130 * Windows: **Friendica Mobile** for Windows versions [before 8.1](http://windowsphone.com/s?appid=e3257730-c9cf-4935-9620-5261e3505c67) and [Windows 10](https://www.microsoft.com/store/apps/9nblggh0fhmn) - developed by [Gerhard Seeber](http://mozartweg.dyndns.org/friendica/profile/gerhard/?tab=profile)