Friendica Communications Platform (please note that this is a clone of the repository at github, issues are handled there) https://friendi.ca
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Developers-Intro.md 8.8KB

4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
2 years ago
4 years ago
4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. # Where to get started to help improve Friendica
  2. <!-- markdownlint-disable MD010 MD013 -->
  3. * [Home](help)
  4. Do you want to help us improve Friendica?
  5. Here we have compiled some hints on how to get started and some tasks to help you choose.
  6. A project like Friendica is the sum of many different contributions.
  7. **Very different skills are required to make good software, not all of them involve coding!**
  8. 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.
  9. Whether you feel like an expert or like a newbie - join us with your ideas!
  10. ## Contact us
  11. The discussion of Friendica development takes place in the following Friendica forums:
  12. * The main [forum for Friendica development](https://forum.friendi.ca/profile/developers)
  13. ## Help other users
  14. Remember the questions you had when you first tried Friendica?
  15. A good place to start can be to help new people find their way around Friendica in the [general support forum](https://forum.friendi.ca/prufile/helpers).
  16. 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.
  17. ## Translation
  18. The documentation contains help on how to translate Friendica [at Transifex](/help/translations) where the UI is translated.
  19. 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?
  20. ## Design
  21. Are you good at designing things?
  22. If you have seen Friendica you probably have ideas to improve it, haven't you?
  23. * If you would like to work with us on enhancing the user interface, please join the [forum for Friendica development](https://forum.friendi.ca/profile/developers).
  24. * Make plans for a better Friendica interface design and share them with us.
  25. * Tell us if you are able to realize your ideas or what kind of help you need.
  26. We can't promise we have the right skills in the group but we'll try.
  27. * Choose a thing to start with, e.g. work on the icon set of your favorite theme
  28. ## Programming
  29. Friendica uses an implementation of [Domain-Driven-Design](help/Developer-Domain-Driven-Design), please make sure to check out the provided links for hints at the expected code architecture.
  30. ### Composer
  31. Friendica uses [Composer](https://getcomposer.org) to manage dependencies libraries and the class autoloader both for libraries and namespaced Friendica classes.
  32. It's a command-line tool that downloads required libraries into the `vendor` folder and makes any namespaced class in `src` available through the whole application through `boot.php`.
  33. If you want to have git automatically update the dependencies with composer, you can use the `post-merge` [git-hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) with a script similar to this one:
  34. #/usr/bin/env bash
  35. # MIT © Sindre Sorhus - sindresorhus.com
  36. # forked by Gianluca Guarini
  37. # phponly by Ivo Bathke ;)
  38. # modified for Friendica by Tobias Diekershoff
  39. changed_files="$(git diff-tree -r --name-only --no-commit-id ORIG_HEAD HEAD)"
  40. check_run() {
  41. echo "$changed_files" | grep --quiet "$1" && eval "$2"
  42. }
  43. # `composer install` if the `composer.lock` file gets changed
  44. # to update all the php dependencies
  45. check_run composer.lock "bin/composer.phar install --no-dev"
  46. just place it into `.git/hooks/post-merge` and make it executable.
  47. * [Class autoloading](help/autoloader)
  48. * [Using Composer](help/Composer)
  49. * [How To Move Classes to `src`](help/Developer-How-To-Move-Classes-to-src)
  50. ### Coding standards
  51. 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.
  52. Here's a few primers if you are new to Friendica or to the PSR-2 coding standards:
  53. * Indentation is tabs, period (not PSR-2).
  54. * 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).
  55. * Operators are wrapped by spaces, e.g. `$var === true`, `$var = 1 + 2` and `'string' . $concat . 'enation'`
  56. * Braces are mandatory in conditions
  57. * Boolean operators are `&&` and `||` for PHP conditions, `AND` and `OR` for SQL queries
  58. * No closing PHP tag
  59. * No trailing spaces
  60. * Array declarations use the new square brackets syntax
  61. * Quoting style is single quotes by default, except for needed string interpolation, SQL query strings by convention and comments that should stay in natural language.
  62. Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica.
  63. There are a few tools you can use to check or fix your files before you commit.
  64. For documentation we use the standard of *one sentence per line* for the `md` files in the `/doc` and `/doc/$lng` subdirectories.
  65. #### Check with [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer)
  66. This tool checks your files against a variety of coding standards, including PSR-2, and ouputs a report of all the standard violations.
  67. You can simply install it through PEAR: `pear install PHP_CodeSniffer`
  68. Once it is installed and available in your PATH, here's the command to run before committing your work:
  69. $> phpcs --standard=ruleset.xml <file or directory>
  70. The output is a list of all the coding standards violations that you should fix before committing your work.
  71. Additionally, `phpcs` integrates with a few IDEs (Eclipse, Netbeans, PHPStorm...) so that you don't have to fiddle with the command line.
  72. #### Fix with PHP Code Beautifier and Fixer (phpbcf) included in PHP Code Sniffer
  73. If you're getting a massive list of standards violations when running `phpcs`, it can be annoying to fix all the violations by hand.
  74. Thankfully, PHP Code Sniffer is shipped with an automatic code fixer that can take care of the tedious task for you.
  75. Here's the command to automatically fix the files you created/modified:
  76. $> phpcbf --standard=ruleset.xml <file or directory>
  77. 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.
  78. ### Code documentation
  79. 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.
  80. The configuration file for Doxygen is located in the base directory of the project sources.
  81. Run
  82. $> doxygen Doxyfile
  83. to generate the files which will be located in the `doc/html` subdirectory in the Friendica directory.
  84. You can browse these files with any browser.
  85. If you find missing documentation, don't hesitate to contact us and write it down to enhance the code documentation.
  86. ### Issues
  87. Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!
  88. * Try to reproduce a bug that needs more inquiries and write down what you find out.
  89. * If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed.
  90. * Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
  91. * There is a *[Junior Job](https://github.com/friendica/friendica/issues?q=is%3Aopen+is%3Aissue+label%3A"Junior+Jobs")* label for issues we think might be a good point to start with.
  92. But you don't have to limit yourself to those issues.
  93. ### Web interface
  94. The thing many people want most is a better interface, preferably a responsive Friendica theme.
  95. This is a piece of work!
  96. If you want to get involved here:
  97. * Look at the first steps that were made (e.g. the clean theme).
  98. Ask us to find out whom to talk to about their experiences.
  99. * Talk to design people if you know any.
  100. * Let us know about your plans [in the dev forum](https://forum.friendi.ca/profile/developers)
  101. Do not worry about cross-posting.
  102. ### Client software
  103. 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.
  104. Furthermore there are several client projects, especially for use with Friendica.
  105. If you are interested in improving those clients, please contact the developers of the clients directly.
  106. * Android / LinageOS: **Friendiqa** [src](https://git.friendi.ca/lubuwest/Friendiqa)/[Google Play](https://play.google.com/store/apps/details?id=org.qtproject.friendiqa) developed by [Marco R](https://freunde.ma-nic.de/profile/marco)
  107. * iOS: *currently no client*
  108. * SailfishOS: **Friendiy** [src](https://kirgroup.com/projects/fabrixxm/harbour-friendly) - developed by [Fabio](https://kirgroup.com/profile/fabrixxm/profile)
  109. * 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/profile)