Commit 41d2644e authored by Michael Shigorin's avatar Michael Shigorin

style.txt: slightly better call for documenting

Sometimes we tend to "just" translate the code to human which doesn't really help; what usually helps is noting down what the code author intended to implement or fix, and what was the case for that.
parent 3b3cf4cc
......@@ -9,7 +9,11 @@
порой могут выясниться непредвиденные последствия;
* документируйте на русском (README) или английском (README.en) языке
то, что написали или изменили.
то, что написали или изменили, если бы сами хотели прочесть описание
сделанного на месте другого человека; в любом случае старайтесь
внятно описывать коммиты, при необходимости также спрашивайте
совета: документация кода порой не менее важна, чем сам код,
и призвана не повторять его, но пояснять намерения и неочевидности.
[float]
=== рекомендации ===
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment