Вклад в BlueBream

Если вы заинтересованы во внесении вклада в проект BlueBream, посетите вики страницу: http://wiki.zope.org/bluebream/ContributingToBlueBream

Ресурсы для разработчиков

Исходный код управляется через репозиторий Zope. Вы можете вытянуть исходники из trunk следующим образом (анонимный доступ):
```
   1    svn co svn://svn.zope.org/repos/main/bluebream/trunk bluebream
```
Вы можете делать изменения в репозиторий после подписания соглашения вкладчика.
Блог проекта
Баги отслеживаются на launchpad
BlueBream Wiki
Страница PyPI
Documentation
Twitter
Список рассылки
IRC канал: #bluebream на irc.freenode.net
Buildbot

Процесс разработки

Создание релизов

Процедура создания релизов, которой следует 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.

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

Обзор

Подсказки

Говорите прямо с читателем

Будьте напористым

Объясняйте ключевые идеи простыми понятиями

Предоставляйте простые примеры

Избегайте разговорных выражений

Предоставляйте ответы, не порождайте вопросы

Пересмотрите предложения, которые говорят мало, или ничего

Документации/Bluebream/BluebreamДляРазработчиков (последним исправлял пользователь RostislavDzinko 2010-07-06 14:47:47)

-  ⇤ ← Версия 3 от 2010-07-05 14:57:58 → 
  Размер: 1021
  Редактор: RostislavDzinko
  Комментарий:
+   ← Версия 14 от 2010-07-06 11:24:46 → ⇥
  Размер: 5840
  Редактор: RostislavDzinko
  Комментарий:
-Удаления помечены так.
+Добавления помечены так.
 Строка 11:
- * The source code is managed at Zope reposistory. You can checkout the trunk code like this (Anonymous access):
+ * Исходный код управляется через [[http://svn.zope.org/bluebream|репозиторий Zope]]. Вы можете вытянуть исходники из trunk следующим образом (анонимный доступ):
 Строка 13:
-svn co svn://svn.zope.org/repos/main/bluebream/trunk bluebream
You can also become a committer after signing a contributor agreement.
+ {{{#!highlight bash
   svn co svn://svn.zope.org/repos/main/bluebream/trunk bluebream
 }}}
-Строка 16:
+Строка 17:
- * Project blog
+ Вы можете делать изменения в репозиторий после подписания [[http://docs.zope.org/developer/becoming-a-committer.html|соглашения вкладчика]].
-Строка 18:
+Строка 19:
- * The bugs and issues are tracked at launchpad.
+ * [[http://bluebream.posterous.com/|Блог проекта]]
-Строка 20:
+Строка 21:
- * BlueBream Wiki.
+ * Баги отслеживаются на [[https://launchpad.net/bluebream|launchpad]]
-Строка 22:
+Строка 23:
- * PyPI page
+ * [[http://wiki.zope.org/bluebream|BlueBream Wiki]]
-Строка 24:
+Строка 25:
- * Documentation
+ * [[http://pypi.python.org/pypi/bluebream|Страница PyPI]]
-Строка 26:
+Строка 27:
- * Twitter
+ * [[http://bluebream.zope.org/|Documentation]]
-Строка 28:
+Строка 29:
- * Mailing list
+ * [[http://twitter.com/bluebream|Twitter]]
-Строка 30:
+Строка 31:
- * IRC Channel: #bluebream at irc.freenode.net
+ * [[https://mail.zope.org/mailman/listinfo/bluebream|Список рассылки]]
-Строка 32:
+Строка 33:
- * Buildbot
+ * IRC канал: [[http://webchat.freenode.net/?randomnick=1&channels=bluebream|#bluebream]] на irc.freenode.net

 * [[http://zope3.afpy.org/buildbot|Buildbot]]
-Строка 38:
+Строка 41:
+Процедура создания релизов, которой следует !BlueBream очень похожа на ту, которой следует ZTK.

Часть [[http://docs.zope.org/zopetoolkit/process/releasing-software.html|официального руководства по созданию релизов]] находится в файле ''CHANGES.txt''. Это важный шаг, который не может быть автоматизирован.

Другими словами, перед началом релиза убедитесь в том, что:

 * Все тесты пройдены
 * Все локальные изменения поступили в репозиторий
 * Журнал изменений (changelog) обновлен.
-Строка 40:
+Строка 53:
+ * Сделать объявление в списке рассылки
 * Сделать запись в блоге
 * Обновить статус в twitter
-Строка 41:
+Строка 58:
+Список проверки релиза на данный момент управляется через вики: http://wiki.zope.org/bluebream/ReleaseChecklist

= Технические решения =

 * !BlueBream - это “веб фреймворк”.

 * Допускается сокращение '''!BlueBream''' как '''Bream''' или '''BB'''. На данный момент сокращение '''BB''' становится все более популярным в сообществе.

 * Есть только один публично доступный API известный как '''bluebream - пакет'''. Этот API - точка входа, предоставляемая setuptools, который использует !PasteScript:
 {{{#!highlight python
  entry_points={
  "paste.paster_create_template":
    ["bluebream = bluebream.bluebream_base.template:BlueBream",
     ]}
 }}}

 * Весь код фреймворка использует пространства имен для пакетов: '''zope''' или '''zope.app''', хотя в будущем может использоваться и '''bb'''.

 * '''проект bluebream''' состоит из шаблонов проектов.

 * '''веб сайт bluebream''' - место хранения веб содержимого.

 * '''bbkit''' - место хранения инфраструктуры KGS.

 * !BlueBream 1.0 должен обеспечивать переход с Zope 3.4 KGS.

 * Любая '''команда оболочки (shell command)''', которая должна повторятся после создания проекта не автоматизируется через шаблон проекта.

 * Запуск ''bootstrap.py'' и ''buildout'' в проекте не должны выполнятся во время создания шаблона проекта исходя из предыдущего пункта. Другая причина в том, что так проще работать с системами контроля версий.

 * дополнительные пакеты, которые содержатся в пространствах имен, таких как '''zc''', '''z3c''', или других, будут добавлены в будущем, но не есть частью релиза версии 1.0.

= Руководство по написанию документации =

== Обзор ==

== Подсказки ==

=== Говорите прямо с читателем ===

=== Будьте напористым ===

=== Объясняйте ключевые идеи простыми понятиями ===

=== Предоставляйте простые примеры ===

=== Избегайте разговорных выражений ===

=== Предоставляйте ответы, не порождайте вопросы ===

=== Пересмотрите предложения, которые говорят мало, или ничего ===

Страница

Пользователь