Tupambae_Org/friendica_2021-01
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #4125 from Rudloff/feature/lint_doc

Browse source 
Lint doc/Developers-Intro.md
This commit is contained in:
Hypolite Petovan 2017-12-23 20:35:58 -05:00 committed by GitHub
commit a7b752df67
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
doc/Developers-Intro.md
View file

@ -1,5 +1,6 @@
Where to get started to help improve Friendica? # Where to get started to help improve Friendica
===============================================
<!-- markdownlint-disable MD010 MD013 -->
* [Home](help) * [Home](help)
@ -10,29 +11,25 @@ A project like Friendica is the sum of many different contributions.
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. 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.
Whether you feel like an expert or like a newbie - join us with your ideas! Whether you feel like an expert or like a newbie - join us with your ideas!
Contact us ## Contact us
---
The discussion of Friendica development takes place in the following Friendica forums: The discussion of Friendica development takes place in the following Friendica forums:
* The main [forum for Friendica development](https://forum.friendi.ca/profile/developers) * The main [forum for Friendica development](https://forum.friendi.ca/profile/developers)
* The [forum for Friendica theme development](https://friendica.eu/profile/ftdevs) * The [forum for Friendica theme development](https://friendica.eu/profile/ftdevs)
Help other users ## Help other users
---
Remember the questions you had when you first tried Friendica? Remember the questions you had when you first tried Friendica?
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). 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).
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. 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.
Translation ## Translation
---
The documentation contains help on how to translate Friendica [at Transifex](/help/translations) where the UI is translated. The documentation contains help on how to translate Friendica [at Transifex](/help/translations) where the UI is translated.
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? 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?
Design ## Design
---
Are you good at designing things? Are you good at designing things?
If you have seen Friendica you probably have ideas to improve it, haven't you? If you have seen Friendica you probably have ideas to improve it, haven't you?
@ -40,11 +37,10 @@ If you have seen Friendica you probably have ideas to improve it, haven't you?
* 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) * 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)
* Make plans for a better Friendica interface design and share them with us. * Make plans for a better Friendica interface design and share them with us.
* Tell us if you are able to realize your ideas or what kind of help you need. * Tell us if you are able to realize your ideas or what kind of help you need.
We can't promise we have the right skills in the group but we'll try. We can't promise we have the right skills in the group but we'll try.
* Choose a thing to start with, e.g. work on the icon set of your favorite theme * Choose a thing to start with, e.g. work on the icon set of your favorite theme
Programming ## Programming
---
### Composer ### Composer
@ -60,13 +56,14 @@ It's a command-line tool that downloads required libraries into the `vendor` fol
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. 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.
Here's a few primers if you are new to Friendica or to the PSR-2 coding standards: Here's a few primers if you are new to Friendica or to the PSR-2 coding standards:
* Indentation is tabs, period (not PSR-2).
* 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). * Indentation is tabs, period (not PSR-2).
* Operators are wrapped by spaces, e.g. `$var === true`, `$var = 1 + 2` and `'string' . $concat . 'enation'` * 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).
* Braces are mandatory in conditions * Operators are wrapped by spaces, e.g. `$var === true`, `$var = 1 + 2` and `'string' . $concat . 'enation'`
* Boolean operators are `&&` and `||` for PHP conditions, `AND` and `OR` for SQL queries * Braces are mandatory in conditions
* No closing PHP tag * Boolean operators are `&&` and `||` for PHP conditions, `AND` and `OR` for SQL queries
* No trailing spaces * No closing PHP tag
* No trailing spaces
Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica. Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica.
There are a few tools you can use to check or fix your files before you commit. There are a few tools you can use to check or fix your files before you commit.
@ -100,7 +97,7 @@ If you are interested in having the documentation of the Friendica code outside
The configuration file for Doxygen is located in the `util` directory of the project sources. The configuration file for Doxygen is located in the `util` directory of the project sources.
Run Run
$> doxygen util/Doxyfile $> doxygen util/Doxyfile
to generate the files which will be located in the `doc/html` subdirectory in the Friendica directory. to generate the files which will be located in the `doc/html` subdirectory in the Friendica directory.
You can browse these files with any browser. You can browse these files with any browser.
@ -111,11 +108,11 @@ If you find missing documentation, don't hesitate to contact us and write it dow
Have a look at our [issue tracker](https://github.com/friendica/friendica) on github! Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!
* Try to reproduce a bug that needs more inquiries and write down what you find out. * Try to reproduce a bug that needs more inquiries and write down what you find out.
* If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed. * If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed.
* Fix a bug if you can. Please make the pull request against the *develop* branch of the repository. * Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
* There is a *Junior Job* label for issues we think might be a good point to start with. * There is a *Junior Job* label for issues we think might be a good point to start with.
But you don't have to limit yourself to those issues. But you don't have to limit yourself to those issues.
### Web interface ### Web interface
@ -124,10 +121,10 @@ This is a piece of work!
If you want to get involved here: If you want to get involved here:
* Look at the first steps that were made (e.g. the clean theme). * Look at the first steps that were made (e.g. the clean theme).
Ask us to find out whom to talk to about their experiences. Ask us to find out whom to talk to about their experiences.
* Talk to design people if you know any. * Talk to design people if you know any.
* Let us know about your plans [in the dev forum](https://forum.friendi.ca/profile/developers) or the [theme developer forum](https://friendica.eu/profile/ftdevs). * Let us know about your plans [in the dev forum](https://forum.friendi.ca/profile/developers) or the [theme developer forum](https://friendica.eu/profile/ftdevs).
Do not worry about cross-posting. Do not worry about cross-posting.
### Client software ### Client software