This repository was archived by the owner on Oct 9, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Various Conventions
yaromir edited this page Mar 4, 2013
·
4 revisions
Различные соглашения команды проекта:
- Вики ведем на русском
Т.к. это внутренняя вещь и проще будет общаться по-русски. Обсуждения технических решений и всякие мелочи вроде ссылок вряд ли представляют большую ценность для человека со стороны. Если когда-нибудь дело дойдет до серьезных документов, например спецификации на формат файлов хинтов, то для этого можно будет создать отдельные документы на английском.
- Заголовок страницы в вики оставляем на английском
Самому не нравится, что заголовок - по-английски, а содержимое - по-русски, но заголовок является частью URL страницы - лучше оставить по-английски.
- Техническое задание пишем на русском
Без вариантов.
- Комментарии документации в коде пишем по-английски
Потому что кроме нас код может быть кто-нибудь когда-нибудь посмотрит.
- Комментарии к коммитам пишем по-английски
Та же причина, что и для комментариев в коде.
- Следуем стандартным code style conventions Python