Merge pull request #4125 from Rudloff/feature/lint_doc

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

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?
@ -43,8 +40,7 @@ If you have seen Friendica you probably have ideas to improve it, haven't you?
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,6 +56,7 @@ 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). * 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). * 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).
* Operators are wrapped by spaces, e.g. `$var === true`, `$var = 1 + 2` and `'string' . $concat . 'enation'` * Operators are wrapped by spaces, e.g. `$var === true`, `$var = 1 + 2` and `'string' . $concat . 'enation'`