Для разработчиков
Содержание
Вклад в BlueBream
Если вы заинтересованы во внесении вклада в проект BlueBream, посетите вики страницу: http://wiki.zope.org/bluebream/ContributingToBlueBream
Ресурсы для разработчиков
Исходный код управляется через репозиторий Zope. Вы можете вытянуть исходники из trunk следующим образом (анонимный доступ):
Переключить отображение номеров строк1 svn co svn://svn.zope.org/repos/main/bluebream/trunk bluebream
Вы можете делать изменения в репозиторий после подписания соглашения вкладчика.
Баги отслеживаются на launchpad
IRC канал: #bluebream на irc.freenode.net
Процесс разработки
Создание релизов
Процедура создания релизов, которой следует BlueBream очень похожа на ту, которой следует ZTK.
Часть официального руководства по созданию релизов находится в файле CHANGES.txt. Это важный шаг, который не может быть автоматизирован.
Другими словами, перед началом релиза убедитесь в том, что:
- Все тесты пройдены
- Все локальные изменения поступили в репозиторий
- Журнал изменений (changelog) обновлен.
Пострелизные шаги
- Сделать объявление в списке рассылки
- Сделать запись в блоге
- Обновить статус в twitter
Список проверки релиза
Список проверки релиза на данный момент управляется через вики: http://wiki.zope.org/bluebream/ReleaseChecklist
Технические решения
BlueBream - это “веб фреймворк”.
Допускается сокращение BlueBream как Bream или BB. На данный момент сокращение BB становится все более популярным в сообществе.
Есть только один публично доступный API известный как bluebream - пакет. Этот API - точка входа, предоставляемая setuptools, который использует PasteScript:
Переключить отображение номеров строк1 entry_points={ 2 "paste.paster_create_template": 3 ["bluebream = bluebream.bluebream_base.template:BlueBream", 4 ]}
Весь код фреймворка использует пространства имен для пакетов: zope или zope.app, хотя в будущем может использоваться и bb.
проект bluebream состоит из шаблонов проектов.
веб сайт bluebream - место хранения веб содержимого.
bbkit - место хранения инфраструктуры KGS.
BlueBream 1.0 должен обеспечивать переход с Zope 3.4 KGS.
Любая команда оболочки (shell command), которая должна повторятся после создания проекта не автоматизируется через шаблон проекта.
Запуск bootstrap.py и buildout в проекте не должны выполнятся во время создания шаблона проекта исходя из предыдущего пункта. Другая причина в том, что так проще работать с системами контроля версий.
дополнительные пакеты, которые содержатся в пространствах имен, таких как zc, z3c, или других, будут добавлены в будущем, но не есть частью релиза версии 1.0.
Руководство по написанию документации
Обзор
Подсказки
Говорите прямо с читателем
Будьте напористым
Объясняйте ключевые идеи простыми понятиями
Предоставляйте простые примеры
Избегайте разговорных выражений
Предоставляйте ответы, не порождайте вопросы