Skip to content

Commit ea58728

Browse files
authored
Added more info about Pull Request
1 parent b16c3a5 commit ea58728

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,34 @@ from some.absolute.path import foo, bar
165165
Рекомендуемый формат документации - [OpenAPI](https://www.openapis.org).
166166
Схема для OpenAPI должна генерироваться "на лету", чтобы обеспечивать клиентов API свежими изменениями.
167167

168-
**Почему?** Потому что это один из распространенных форматов для документирования REST API, которая вышла из Swagger. Данный формат документации поддерживается большим количеством клиентов (Swagger, Postman, Insomnia Designer и многие другие). Также, рукописная документация имеет свойство быстро устаревать, а документация, которая генерируется напрямую из кода позволяет не думать о постоянных обновлениях документации.
168+
**Почему?** Потому что это один из распространенных форматов для документирования REST API, которая вышла из Swagger. Данный формат документации поддерживается большим количеством клиентов (Swagger, Postman, Insomnia Designer и многие другие). Также, рукописная документация имеет свойство быстро устаревать, а документация, которая генерируется напрямую из кода позволяет не думать о постоянном обновлении документации.
169169

170170

171-
## Pull Request
172-
Дифф PR не должен превышать +/- 1000 строк.
171+
## Про Pull Request
172+
**1 Pull Request = 1 issue**
173+
174+
Один Pull Request должен решать ровно одно issue.
175+
176+
**Почему?** Потому что ревьюверу сложнее держать контекст нескольких задач в голове и переключаться между ними.
177+
178+
179+
## Размер Pull Request
180+
Итоговый дифф PR не должен превышать +/- 600 измененных строк.
181+
182+
Плохо ❌:
183+
184+
![bad](https://user-images.githubusercontent.com/8825727/113953748-6fc7ba80-9853-11eb-9673-827995e54f73.png)
185+
```
186+
Дифф 444 + 333 = 777
187+
```
188+
189+
Хорошо ✅:
190+
191+
![good](https://user-images.githubusercontent.com/8825727/113953831-a30a4980-9853-11eb-854b-d4c4f6559f2c.png)
192+
```
193+
Дифф 222 + 111 = 333
194+
```
195+
173196
174197
**Почему?** Потому что чем больше PR - тем более он становится неконтролируемым и мерж производится "закрыв глаза и заткнув уши".
175198
Также, большинству ревьюверов будет сложно воспринять такой объем изменений за один раз.

0 commit comments

Comments
 (0)