Вклад в код

Большое спасибо за вклад в WeCross!

Стратегия ветвления

В проекте используется стратегия ветвления git-flow.

• master: последняя стабильная ветка;
• dev: ветка, готовая к выпуску;
• feature-xxxx: ветка разработки новой функции xxxx;
• bugfix-xxxx: ветка исправления ошибки xxxx.

Как внести свой вклад

Создание задачи

Можно напрямую создать задачу на странице issues page.

Исправление ошибок

1. Форкните этот репозиторий в личный репозиторий.
2. Создайте ветку bugfix-xxxx из ветки master личного репозитория.
3. Исправьте ошибку в ветке bugfix-xxxx.
4. Протестируйте исправление ошибки.
5. Отправьте запрос на слияние (PR) в ветку dev этого репозитория.
6. Дождитесь проверки PR сообществом.
7. Запрос на слияние будет принят, и ошибка будет исправлена!

Разработка новых функций

1. Форкните этот репозиторий в личный репозиторий.
2. Создайте ветку feature-xxxx из ветки dev личного репозитория.
3. Разработайте новую функцию в ветке feature-xxxx.
4. Периодически извлекайте последние изменения из ветки dev этого репозитория в ветку feature-xxxx.
5. Протестируйте новую функцию.
6. Отправьте запрос на слияние (PR) в ветку dev этого репозитория.
7. Дождитесь проверки PR сообществом.
8. Запрос на слияние будет принят, и разработка новой функции завершена!

Форматирование кода

Для форматирования кода используется плагин gradle google-java-format-gradle-plugin.

Выполните задачу googleJavaFormat для форматирования java-файлов.

./gradlew goJF

Выполните задачу verifyGoogleJavaFormat, чтобы проверить, отформатированы ли java-файлы.

./gradlew verGJF