Руководство по работе с Git для этого проекта

Познакомьтесь с моделью сотрудничества Git — есть много ресурсов для этого!

Создайте форк этого репозитория, и отправьте все свои изменения в вашу копию. Убедитесь, что ваша ветка актуальна относительно центрального репозитория перед тем, как сделать запрос на слияние. Git-scm хорошо описывает эту модель.

Следуйте этим руководствам в частности:

1. поддерживайте функциональность upstream/master
2. пишите полезные сообщения коммитов
3. используйте commit --amend или rebase для избежания публикации серии "ошибочных" коммитов (лучше это делать на вашей собственной ветке, а не на master) (прочитайте это)
4. ...но не изменяйте опубликованную историю
5. предпочитайте rebase master к merge master, снова для того, чтобы поддерживать чистую историю. Не делайте этого, если вы не полностью уверены в том, как работает rebase.
6. отслеживайте задачи с помощью инструментов GitHub

Руководство по написанию кода

Мы используем Python 2.7. Я рекомендую использовать virtualenv для настройки окружения; requirements.txt содержит необходимые модули Python. Кроме того, следуйте этим руководствам:1. помните, что "код читается чаще, чем пишется"

1. избегайте преждевременной оптимизации. Вместо этого будьте педантичны и ясны в коде, и мы будем делать целевые оптимизации позже с помощью профилировщика
2. пишите тесты. Это скрипты, которые фактически пытаются сломать ваш собственный код и убедиться, что ваши классы и функции могут справиться с тем, что на них бросают
3. документируйте каждый класс и каждую функцию, комментируйте обильно