crossBILLy

crossBILLy - Михаил Алексеев

@alekseew/ crossBILLy

Этот репозиторий содержит веб- и кросс-платформенное приложение (Web PWA, Windows, Mac OS X, iOS и Android) для удобного формирования счетов. Этот проект должен помочь хранить данные о клиентах, выставлять счета/фактуры,...

Используемые или тестируемые фреймворки, платформы, библиотеки, плагины, концепции, архитектуры, методы... следующие:

• Модель ветвления системы управления исходным кодом: GitFlow
• Платформа/фреймворк внешнего веб-приложения: Angular
• Инструмент/фреймворк для кросс-платформенной сборки: ионный конденсатор или Cordova и Electron
• Язык разработки: Typescript /( JavaScript )
• Библиотека пользовательского интерфейса WebApp: Angular Material
• Библиотека поведения пользовательского интерфейса WebApp: Angular CDK
• Форматирование кода: красивее
• Управление версиями, автоматический журнал изменений (релизы): стандартная версия
• Инструмент сообщения о фиксации: Commitizen
• Инструмент Git-Hooks: Husky
• Анимации: Лотти и Лотти-Веб
• Хостинг и многое другое... : FireBase
• Непрерывная интеграция (CI) / Тестирование и сборка: Трэвис
• Мониторинг зависимостей: Greenkeeper
• будет продолжение...

Предварительные условия

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

• Node.js
• НПМ

Зависимости

Чтобы установить все необходимые зависимости, просто запустите:

npm install

Это также настроит шаблон сообщения о фиксации git (и настроит пакет wip на использование commitizen).

GitFlow

Пожалуйста, используйте модель ветвления GitFlow и имена по умолчанию для ветвей SourceTree в этом проекте. Дополнительную информацию можно найти здесь:

• GitFlow
• Исходное дерево + GitFlow

Соглашение об именах имен ветвей и префиксов (настройка по умолчанию в SourceTree):

• Производственное направление: мастер
• Ветка развития: разработка
• Префикс ветки функции: функция/
• Префикс ветки выпуска: Release/
• Префикс ветки исправлений: hotfix/
• Нет префикса тега версии (имена тегов будут, например, v0.1.0)

Обычный журнал изменений/фиксации

В этом проекте (угловом) используются обычные коммиты Angular Commit Message Guidelines .

Они будут использоваться для автоматического создания журнала изменений со стандартной версией пакета npm. Для этого просто запустите npm run release . Это позволит выполнить следующую задачу:

• Обновить версию проекта
• Создать/обновить CHANGELOG.md
• Зафиксируйте эти изменения (готовы отправить их на удаленный компьютер)
• Создать тег git

Вы можете использовать npm run commit , чтобы получить мастер, который поможет вам написать правильные сообщения о фиксации (это делается с помощью commitizen ).

Также сообщения о коммитах будут проверены на корректность с помощью commitlint (если вам действительно нужно пропустить это, вы можете обойти гитхуки, но обычно делать это не следует).

Вы можете создать шаблон сообщения о фиксации git с помощью npm run prepare-git-commit-template , это также будет сделано во время установки npm.

Формат сообщения фиксации

Заголовок (состоящий из типа , области действия и темы ) не должен быть длиннее 72 символов.

 type(scope?): subject

body?

footer?

Тип

Должно быть одно из следующих:

• подвиг : Новая функция
• fix : Исправление ошибки
• документы : только изменения в документации.
• стиль : изменения, не влияющие на смысл кода (пробелы, форматирование, отсутствие точек с запятой и т. д.).
• рефакторинг : изменение кода, которое не исправляет ошибку и не добавляет функцию.
• perf : изменение кода, улучшающее производительность.
• test : добавление отсутствующих тестов или исправление существующих тестов.
• build : изменения, влияющие на систему сборки, конфигурацию CI или внешние зависимости (примерные области: gulp, broccoli, npm).
• ci : изменения в наших файлах конфигурации и сценариях CI (примеры областей: Travis, Circle, BrowserStack, SauceLabs).
• рутинная работа : другие изменения, которые не изменяют src или test файлы.
• revert : возвращает предыдущую фиксацию.

Объем

Областью действия может быть что угодно, указывающее место изменения фиксации. Я использую следующие соглашения (примеры):

• all : изменения для всего проекта (общий выпуск проекта,...)
• root : изменения в корне (папке) проекта
• be : изменения в бэкэнд-части проекта
• fe : изменения во фронтенд-части (веб-приложение) проекта

Предмет

В теме содержится краткое описание изменения:

• используйте повелительное наклонение в настоящем времени: «изменение», а не «изменение» или «изменения».
• не делайте первую букву заглавной
• нет точки (.) в конце

Тело

Как и в теме , используйте повелительное наклонение настоящего времени: «изменение», а не «изменение» или «изменения». Организм должен включить мотивацию к изменению и противопоставить ее предыдущему поведению.

Нижний колонтитул

Нижний колонтитул должен содержать любую информацию о критических изменениях , а также место для ссылки на проблемы JIRA, которые этот коммит закрывает .

Критические изменения должны начинаться со слова BREAKING CHANGE: через пробел или две новые строки. Остальная часть сообщения фиксации затем используется для этого.

Фиксирующие хуки

В этом репозитории используются git-хуки (настраиваются с помощью хаски ) для проверки «чистого» исходного кода.

Более красивая проверка формата

Если файлы Typescript или SCSS изменяются и нажимаются, срабатывает перехватчик фиксации, и промежуточные файлы форматируются с использованием более красивого формата. Он выполняет форматирование/изменение, фиксирует и отправляет эти изменения с помощью довольно быстрого .

Проверка сообщения фиксации

Проверяет, является ли сообщение фиксации git обычным сообщением фиксации git, в противном случае фиксация будет отменена.

Версия и выпуск проекта

Последний коммит в ветке выпуска должен установить версию проекта и создать журнал изменений, это нужно сделать с помощью npm run release . Этот набор представляет собой версию проекта , генерирует журнал изменений и фиксирует эти изменения . Дополнительную информацию можно найти в главе: Обычный журнал изменений/коммиты.

Продолжается интеграция и развертывание

В этом проекте Travis CI настроен как lint-, test-, e2e-tests- и build-slave. Если все было протестировано и построено успешно, Travis CI развернет WebApp в FireBase .