Вклад в проект Mars

Добро пожаловать для отправки сообщений об ошибках (report Issues) или запросов на включение кода (pull requests). Перед отправкой рекомендуется сначала ознакомиться с Руководством по внесению вклада.

Сообщения об ошибках

Мы используем Github Issues для отслеживания публичных ошибок и запросов на добавление функций.

Сначала поищите известные ошибки

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

Отправка новых сообщений об ошибках

Если вы открываете проблему, чем больше информации, тем лучше. Например, подробное описание, скриншот или видео вашей проблемы, logcat и xlog или блоки кода для вашего сбоя.

Запросы на включение кода

Мы приветствуем ваши запросы на включение кода, которые делают Mars лучше.

Управление ветками

Существует три основных ветки:

1. Ветвь master.
   1. Это последняя (предварительная) версия выпуска. Мы используем master для тегов с номером версии 1.1.0, 1.2.0, 1.3.0...
   2. Не отправляйте PR на ветвь master.
2. Ветвь develop.
   1. Это наша стабильная ветка разработки. После полного тестирования develop будет объединена с ветвью master для следующего выпуска.
   2. Рекомендуется отправлять PR для исправления ошибок или добавления функций на ветвь develop.
3. Ветвь hotfix.
   1. Это последний тег версии для горячего исправления. Если мы примем ваш запрос на включение, мы можем просто пометить его номером версии 1.1.1, 1.2.3.
   2. Только отправляйте срочные PR на ветвь hotfix для следующего конкретного выпуска.

Обычные исправления ошибок или запросы на добавление функций должны отправляться на ветвь develop. После полного тестирования мы объединим их с ветвью master для следующего выпуска.

Если у вас есть срочные исправления ошибок в опубликованной версии, но ветвь master уже далеко от последней версии тега, вы можете отправить PR на hotfix. И если это возможно, он будет выбран для ветви develop.

master
 ↑
develop        <--- hotfix PR
 ↑ 
feature/bugfix PR

Создание запросов на включение

Команда разработчиков будет отслеживать все запросы на включение. Мы запускаем проверку кода и тестирование. После успешного прохождения всех тестов мы примем этот PR. Но он не будет сразу объединён с master, что может занять некоторое время.

Перед отправкой запроса на включение убедитесь, что выполнено следующее:

1. Форкните репозиторий и создайте свою ветку из master или hotfix.
2. Обновите код или документацию, если вы изменили API.
3. Добавьте уведомление об авторских правах в начало любых новых файлов, которые вы добавили.
4. Проверьте стили кода и стили проверки.
5. Протестируйте и ещё раз протестируйте свой код.
6. Теперь вы можете отправить свой запрос на включение на ветвь develop или hotfix.

Руководство по стилю кода

Используйте Руководство по стилю для C/C++.

• 4 пробела для отступа вместо табуляции.
• Частная функция должна начинаться с "__".
• Параметры функции должны начинаться с "_".

Лицензия

Внося вклад в Mars, вы соглашаетесь, что ваши вклады будут лицензированы в соответствии с его MIT LICENSE.