Главная » Статьи » Документация » Для разработчиков
Категории

Работа с репозиториями и версионирование

Бесплатная CMS AtomX является opensource проектом. По-этому каждый желающий разработчик может помогать в развитии проекта. Более того - мы будем этому очень рады). Помощь может выражаться по-разному, будь то написание кода, тестирование или материальная помощь проекту. Тут Вы найдете информацию о репозиториях AtomX CMS и их назначении, а так же дополнительную информацию о контактах основных разработчиков.

Code-style

Большая просьба, при написании кода, соблюдать кодстайл применяемый в AtomX и следовать изначально заданной архитектуре. Например, если в AtomX работа с базой ведется через ORM, то так и следует продолжать, а не делать запросы напрямую или подключать свои, избыточные библиотеки.

Версионирование

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

Пример: МАЖОР.МИНОР.ПАТЧ (2.7.11)
В этом случае:
  • МАЖОР - меняем если была утеряна обратная совместимость.
  • МИНОР - меняем если был добавлен новый функционал, не ломающий совместимости. Обнуляется при изменении МАЖОР.
  • ПАТЧ - увеличиваем при каждом изменении. Обнуляется при изменении МИНОР или МАЖОР.


Использование репозиториев

Обратите внимание, что для разработки используется ветка master. Для релизных сборок создаются основные ветки. По-этому желательно отправлять в pull-request рабочий и протестированный код.

Основной репозиторий AtomX

GitHub
Скачать
Баг трекер


Репозиторий AtomShop

GitHub
Скачать
Баг трекер


Репозиторий AtomBlog

GitHub
Скачать
Баг трекер


Репозиторий плагинов

GitHub
Баг трекер
В данном репозитории отсутствует понятие релиз, так как плагины не скачиваются с ГитХаб, а устанавливаются с сервера AtomX через панель управления сайтом. На сервер раздачи плагины переносятся вручную модератором. Другими словами, после обновления плагина в репозитории, он тестируется и проверяется на вредоносный код, после чего експортируется на сервер раздачи.

Не забывайте, что каждый плагин должен содержать файл meta.dat, с JSON данными, содержащими название, описание и версию AtomX которая поддерживает этот плагин.
Например:
Code:
{
    title: Title,
    description: Description,
    fps_version: 2.7.11
}

Так же Вы можете добавить скриншот плагина. Просто положите изображение screenshot.png в корень директории плагина. Размер изображения должен быть 300 х 300 px.


Контакты

Вы можете связаться напрямую со мной и пообщаться в частном порядке или попроситься в групповой чат AtomX.
Скайп - drunyacoder
Мыло - drunyacoder[СОБАКА]mail.ru
Для разработчиков Просмотров: 1411 Комментариев: 0