contribution.md

Правила помощи проекту

Любой желающий может помочь в разработке проекта ClienD extension (Расширение ClienD). Эта инструкция обязательна к прочтению перед тем, как Вы начнете помогать этому проекту.

Структура файлов

Есть определенные правила хранения файлов в проекте:

• fonts - шрифты
• images - картинки
• js - javascript файлы
  • fixtures - папка с "фиксами" для edu.tatar.ru. Структура папок и файлов соответствует структуре адресов edu.tatar.ru
    • admin - личный кабинет администратора сайта
      • page
        • news
          • edit - код, выполняемый на странице edu.tatar.ru/admin/page/news/edit (страница добавления/изменения новостей)
            • extension.js - уровень расширения (content script)
            • page.js - уровень страницы. Подключается из content script файла.
          • edit.js - код для страницы edu.tatar.ru/admin/page/edit/ (изменение элемента структуры сайта)
          • simple_pages.js - код для страницы edu.tatar.ru/admin/page/simple_page (список страниц)
    • school
      • journal - электронный журна
        • extension.js - уровень расширения
        • page.js - уровень страницы
  • libs - внешние библиотеки
  • bg.js - фоновый скрипт. Подробнее в официальной документации
• pages - страницы расширения
  • popup.html - всплывающее окно
• styles - стили
  • fixtures - стили для "фиксов" на edu.tatar.ru. Структура аналогична папке js/fixtures
  • libs - внешние стили manifest.json - манифест расширения. Подробнее в официальной документации

Запуск версии для разработки

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

• Склонировать репозиторий (скачать код)
• Зайти на страницу расширений Chrome (chrome://extensions/)
• Включить Режим разработчика
• Нажать на кнопку Загрузить распакованное расширение
• Указать путь до папки с кодом
• Готово!

Не забудьте удалить стабильную версию расширения, иначе код будет выполняться на страницах несколько раз.

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

Основные изменения должны вноситься в файлы в папках js/fixtures, styles/fixtures и в файл manifest.json. Именно в нем есть специальная секция, которая запускает скрипты на страницах сайтов.

Изменения в проект принимаются с помощью pull-request`ов. Если Вы не знаете, что это такое, вот хорошая статья для изучения данной темы.

Связь с авторами

Любые возникающие вопросы Вы можете написать на support@clienddev.ru или лично разработчику расширения Артуру Атнагулову artur@clienddev.ru.

Если Вы хотите сообщить о проблеме или предложить функцию, добавьте issue.