aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers/01_First_steps.md
diff options
context:
space:
mode:
authorGravatar Frans de Jonge <fransdejonge@gmail.com> 2019-12-03 22:37:40 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2019-12-03 22:37:40 +0100
commit705318aa39a605a4d869db588f6cffb12019a611 (patch)
tree36383dfee24999f9928957621b655e67b20714b7 /docs/en/developers/01_First_steps.md
parent0de7e84380dff5222e6728aacbbb42abaac51dd9 (diff)
Translate docs with po4a (#2590)
* [i18n] Add docs po4a script * Add proof of concept * Add a few more translations * Hush ShellCheck and shfmt * Make that list po4a-friendly * drat, this document could've probably been auto-generated * Definitive proof that it's translated from French ;-) * Add some brand spanking new French translation * More translation * Mostly finish that config page * Fix up FAQ * More contributing * Dev first steps * Let's ignore that admin stuff at the very least for now * Translate release new version, make French the source first and copy all translations Then replace French with English in the source. Much quicker than any alternative route. * And add the English translation * Minor stylistic leftover from French * Most of first steps * Forgot the extensions * Use po4a 0.56 to get rid of way too many newlines * Fix up those newlines * No point linking to Firefox integration anymore from the new user guide * Start on main view * A bunch of main view stuff * More main view * And some subscriptions before going to bed * First steps for devs * More dev first steps * Incomplete French → English dev/GH translation Because I need to ask about that mailing list thing * Fix typo in docs/en/developers/02_Github.md * Translate & complete devs/github to English * Fix up most of extensions * Is that supposed to be a non-breaking space? Let's see * Match up some users/mobile access * More users/mobile access * Add fresh French translation to Fever API * Fix typo * Match frontend todo thingies * Fix a typo * Some extensions strings * Remove Fx subscription service from the docs Cf. https://github.com/FreshRSS/FreshRSS/pull/2606 * Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643 * fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009 * Add some more French translations * Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909 * Translate some of the meaningless stuff * Translate the rest of contributing.md to French * Fix conflicts * Translate Docker first steps to French * Update with change from #2665 * Add @aledeg corrections * Overlooked a couple @aledeg corrections thanks to GitHub autohide * Latest @aledeg suggestions
Diffstat (limited to 'docs/en/developers/01_First_steps.md')
-rw-r--r--docs/en/developers/01_First_steps.md52
1 files changed, 26 insertions, 26 deletions
diff --git a/docs/en/developers/01_First_steps.md b/docs/en/developers/01_First_steps.md
index 28c249be4..6c6177aec 100644
--- a/docs/en/developers/01_First_steps.md
+++ b/docs/en/developers/01_First_steps.md
@@ -45,7 +45,7 @@ $ TAG=dev-arm make start
You can find the full list of available tags [on the Docker hub](https://hub.docker.com/r/freshrss/freshrss/tags).
-You might want to rebuild the Docker image locally. You can do it with:
+If you want to build the Docker image yourself, you can use the following command:
```console
$ make build
@@ -65,18 +65,18 @@ If you want to create your own FreshRSS extension, take a look at the [extension
# Coding style
-If you want to contribute to the source code, it is important to follow the project coding style. The actual code does not follow it throughout the project, but every time we have an opportunity, we should fix it.
+If you want to contribute to the source code, it's important to follow the project's coding style. The actual code doesn't always follow it throughout the project, but we should fix it every time an opportunity presents itself.
-Contributions which do not follow the coding style will be rejected as long as the coding style is not fixed.
+Contributions which don't follow the coding style will be rejected as long as the coding style is not fixed.
-## Spaces, tabs and white spaces
+## Spaces, tabs and other whitespace characters
-### Indent
-Code indent must use tabs.
+### Indentation
+Code indentation must use tabs.
### Alignment
-Once the code is indented, it might be useful to align it to ease the reading. In that case, use spaces.
+Once the code has been correctly indented, it might be useful to align it for ease of reading. In that case, please use spaces.
```php
$result = a_function_with_a_really_long_name($param1, $param2,
@@ -85,9 +85,9 @@ $result = a_function_with_a_really_long_name($param1, $param2,
### End of line
-The end of line character must be a line feed (LF) which is a default end of line on *NIX systems. This character must not follow other white spaces.
+The newline character must be a line feed (LF), which is the default line ending on *NIX systems. This character must not follow other white space.
-It is possible to verify if there is white spaces before the end of line, with the following Git command:
+You can verify if there is any unintended white space at the end of line with the following Git command:
```bash
# command to check files before adding them in the Git index
@@ -100,13 +100,13 @@ git diff --check --cached
Every file must end by an empty line.
-### With commas, dots and semi-columns
+### Commas, dots and semi-columns
-There is no space before those characters but there is one after.
+There should no space before those characters, but there should be one after.
-### With operators
+### Operators
-There is a space before and after every operator.
+There should be a space before and after every operator.
```php
if ($a == 10) {
@@ -116,9 +116,9 @@ if ($a == 10) {
echo $a ? 1 : 0;
```
-### With brackets
+### Parentheses
-There is no spaces in the brackets. There is no space before the opening bracket except if it is after a keyword. There is no space after the closing bracket except if it is followed by a curly bracket.
+There should be no spaces in between brackets. There should be no spaces before the opening bracket, except if it's after a keyword. There shouldn't be any spaces after the closing bracket, except if it's followed by a curly bracket.
```php
if ($a == 10) {
@@ -132,7 +132,7 @@ if ((int)$a == 10) {
### With chained functions
-It happens most of the time in Javascript files. When there is chained functions, closures and callback functions, it is hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level.
+It happens most of the time in Javascript files. When there are chained functions with closures and callback functions, it's hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level.
```javascript
// First instruction
@@ -151,9 +151,9 @@ shortcut.add("shift+" + shortcuts.mark_read, function () {
## Line length
-Lines should be shorter than 80 characters. However, in some case, it is possible to extend that limit to 100 characters.
+Lines should strive to be shorter than 80 characters. However, this limit may be extended to 100 characters when strictly necessary.
-With functions, parameters can be declared on different lines.
+With functions, parameters can be declared on multiple lines.
```php
function my_function($param_1, $param_2,
@@ -164,11 +164,11 @@ function my_function($param_1, $param_2,
## Naming
-All the code elements (functions, classes, methods and variables) must describe their usage in concise way.
+All code elements (functions, classes, methods and variables) must describe their usage succinctly.
### Functions and variables
-They must follow the "snake case" convention.
+Functions and variables must follow the "snake case" naming convention.
```php
// a function
@@ -181,7 +181,7 @@ $variable_name;
### Methods
-They must follow the "lower camel case" convention.
+Methods must follow the "lower camel case" naming convention.
```php
private function methodName() {
@@ -191,7 +191,7 @@ private function methodName() {
### Classes
-They must follow the "upper camel case" convention.
+Classes must follow the "upper camel case" naming convention.
```php
abstract class ClassName {}
@@ -199,16 +199,16 @@ abstract class ClassName {}
## Encoding
-Files must be encoded with UTF-8 character set.
+Files must be encoded with the UTF-8 character set.
## PHP compatibility
-Ensure that your code is working with a PHP version as old as what FreshRSS officially supports.
+Please ensure that your code works with the oldest PHP version officially supported by FreshRSS.
## Miscellaneous
### Operators
-They must be at the end of the line if a condition runs on more than one line.
+Operators must be at the end of the line if a condition is split over more than one line.
```php
if ($a == 10 ||
@@ -223,7 +223,7 @@ If the file contains only PHP code, the PHP closing tag must be omitted.
### Arrays
-If an array declaration runs on more than one line, each element must be followed by a comma even the last one.
+If an array declaration runs on more than one line, each element must be followed by a comma, including the last one.
```php
$variable = [