Skip to content

Commit 2770b73

Browse files
committed
WIP
1 parent d04a944 commit 2770b73

6 files changed

Lines changed: 17 additions & 14 deletions

File tree

content/002-readme.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@
1212
На практике `README` часто либо отсутствует, либо существует лишь как формальность.
1313
Такое встречается в репозиториях компаний любого масштаба.
1414

15-
Например, в корне может лежать пустой или шаблонный `README`, созданный автоматически при инициализации — и на этом всё.
16-
Иногда файл содержит только заголовок `# ProjectName`, без единого слова о сути проекта. А в худшем случае `README`
15+
Например, в корне может лежать пустой или шаблонный файл `README`, созданный автоматически при инициализации — и на этом всё.
16+
Иногда файл содержит только заголовок
17+
`# ProjectName`, без единого слова о сути проекта. А в худшем случае `README`
1718
вообще нет, зато рядом находятся десятки разрозненных скриптов и несколько почти одинаковых конфигурационных файлов:
18-
`config_old.php`, `config_bak.php`, `config_real_final.php`.
19+
`config_old.php`, `config_bak.php`,
20+
`config_real_final.php`.
1921

2022
Что с этим делать?
2123
Начать с простого — представить, что репозиторий открыл разработчик, который впервые видит этот проект.
@@ -87,6 +89,7 @@ make reset-db
8789
```shell
8890
# Для запуска всех тестов:
8991
vendor/bin/phpunit
92+
9093
# или для запуска тестов в определённой тестовой группе:
9194
vendor/bin/phpunit --testsuite=Browser
9295
```
@@ -103,6 +106,8 @@ vendor/bin/phpunit --testsuite=Browser
103106
Допустим, вы работаете над внутренним проектом Weather — платформой для анализа метеоданных.
104107
Вам поручили реализовать класс, вычисляющий лунную фазу, чтобы добавить его в блок астрономического прогноза.
105108

109+
В какой директории вы создадите этот класс:
110+
106111
- В `components`?
107112
- В `modules`?
108113
- В `services`?

content/003-big.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<div style="page-break-after: always;"></div>
1111

12-
Его используют:
12+
Его по умолчанию используют:
1313

1414
- Laravel (PHP)
1515
- Django (Python)

content/004-communication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
> Я ПРОГРАМИСТ с БОЛЬЩИМ апытом делал сайты и приложения для интирнета. Пишу код на джаве и пхп ещо умею с питон и руби.
4242
> Работал в разны места делал всьо што гаварили.
4343
> Харашо разбераюсь в компютерах и серварах, могу делать апдейт и чинить баги.
44-
> Если вазьмёте меня, не пажелеете, я осен стараюс.
44+
> Если вазьмёте меня, не пажелеете, я осен-осен стараюс.
4545
4646
Дочитывать не хочется, а приглашать на собеседование — тем более.
4747
Даже если письмо будет оформлено без ошибок, оно всё равно может произвести не лучшее впечатление:

content/006-code-breath.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
<div style="page-break-after: always;"></div>
1414

1515
Плохая новость:
16-
> {warning}
1716
> **Ни один автоматический инструмент форматирования не научит ваш код дышать.**
1817
1918
Рассмотрим пример:

content/007-naming.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class Order extends Controller
4747
{
4848
// ...
4949
foreach ($zakazy as $tovar) {
50-
$product->otpravka($tovar);
50+
$product->otpravka($tovar);
5151
}
5252
// ...
5353
}
@@ -101,7 +101,7 @@ $user = User::find($id);
101101
// Плохо [✗]
102102
class UsrCtrl extends Ctrl {
103103
public function f() {
104-
// ...
104+
// ...
105105
}
106106
}
107107
```
@@ -116,7 +116,7 @@ class ProfileController extends Controller
116116
{
117117
public function show()
118118
{
119-
// ...
119+
// ...
120120
}
121121
}
122122
```
@@ -127,7 +127,7 @@ class ProfileController extends Controller
127127

128128
Некоторые даже добавляют:
129129

130-
> «Пусть имя будет длинным — это сделает код понятнее».
130+
> «Пусть имя будет длинным — это сделает код самодокументированным и более понятным».
131131
132132
Нет. Не делает.
133133
Особенно если это имя — дымовая завеса над тем, что в коде нет ни логики, ни смысла.

content/013-arguments.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,9 @@ $fileSystem
145145
Стоит отдельно упомянуть, что многие разработчики и известные авторы, например, Роберт Мартин — автор "Чистого кода",
146146
считают использование булевых аргументов признаком плохого тона. И предлагают создавать отдельный метод вместо передачи
147147
булева значения.
148+
149+
<div style="page-break-after: always;"></div>
150+
148151
Например, вместо:
149152

150153
```php
@@ -188,8 +191,6 @@ $fileSystem->reWrite(
188191
// Плохо [✗]
189192
class ExcludeList
190193
{
191-
private array $list = [];
192-
193194
public function add(
194195
string $itemName,
195196
string $itemIdentityName,
@@ -217,8 +218,6 @@ class ExcludeList
217218
// Хорошо [✓]
218219
class ExcludeList
219220
{
220-
private array $list = [];
221-
222221
public function add(Model $model): static
223222
{
224223
$key = $model->getKey();

0 commit comments

Comments
 (0)