GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[DOCUMENTATION] Adopt PSR-12 and clarify on arrays

Browse Source
This commit is contained in:
Alexei Sorokin 2020-07-27 19:19:42 +03:00 committed by Diogo Peralta Cordeiro
parent b1b1d2af93
commit 903a9d2667
2 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
DOCUMENTATION/DEVELOPERS/CONTRIBUTING/coding_standards.md
View File

@ -1,7 +1,7 @@
GNU social Coding Style GNU social Coding Style
=========================== ===========================
Please comply with [PSR-2](https://www.php-fig.org/psr/psr-2/) and the following standard when working on GNU social Please comply with [PSR-12](https://www.php-fig.org/psr/psr-12/) and the following standard when working on GNU social
if you want your patches accepted and modules included in supported releases. if you want your patches accepted and modules included in supported releases.
If you see code which doesn't comply with the below, please fix it :) If you see code which doesn't comply with the below, please fix it :)
@ -118,7 +118,7 @@ Some short hands are evil:
Naming conventions Naming conventions
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Respect PSR2 first. Respect PSR-12 first.
- Classes use PascalCase (e.g. MyClass). - Classes use PascalCase (e.g. MyClass).
- Functions/Methods use camelCase (e.g. myFunction). - Functions/Methods use camelCase (e.g. myFunction).
@ -145,11 +145,29 @@ Also, whereever possible, avoid ambiguous terms. For example, don't use text
as a term for a variable. Call back to "contents" above. as a term for a variable. Call back to "contents" above.
Arrays
-------------------------------------------------------------------------------
Even though PSR-12 doesn't specifically specify rules for array formatting, it
is in the spirit of it to have every array element on a new line like is done
for function and class method arguments and condition expressions, if there is
more than one element.
In this case, even the last element should end on a comma, to ease later
element addition.
$foo = ['first' => 'unu'];
$bar = [
'first' => 'once',
'second' => 'twice',
'third' => 'thrice',
];
Comparisons Comparisons
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Always use symbol based comparison operators (&&, ||) instead of text based Always use symbol based comparison operators (&&, ||) instead of text based
operators (AND, OR) as they are evaluated in different orders and at different operators (and, or) in an "if" clause as they are evaluated in different order
speeds. This is will prevent any confusion or strange results. and at different speeds.
This is will prevent any confusion or strange results.
Use English Use English

2
plugins/ActivityPub/CONTRIBUTING.md
View File

@ -6,7 +6,7 @@ email, or any other method with the owners of this repository before making a ch
Please note we have a code of conduct, please follow it in all your interactions with the project. Please note we have a code of conduct, please follow it in all your interactions with the project.
# Coding Style # Coding Style
- We follow every [PSR-2](https://www.php-fig.org/psr/psr-2/) ... - We follow every [PSR-12](https://www.php-fig.org/psr/psr-12/) ...
- ... except camelCase, that's too bad, we use snake_case - ... except camelCase, that's too bad, we use snake_case
## Merge Request Process ## Merge Request Process