Внесение вклада в VasSonic

Добро пожаловать для отправки отчётов об ошибках или пулл-реквестов. Перед внесением вклада рекомендуется сначала прочитать следующее руководство по внесению вклада.

Отчёты об ошибках

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

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

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

Отправка отчётов о новых ошибках

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

Пулл-реквесты

Мы настоятельно приветствуем ваши пулл-реквесты, которые делают VasSonic лучше.

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

Здесь есть две основные ветки:

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

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

master
 ↑
dev   
 ↑ 
PR с исправлением ошибки или добавлением функции

Создание пулл-реквеста

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

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

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

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

Используйте Code Style для Java и Android.

• 4 пробела для отступа вместо табуляции.

Лицензия

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