CONTRIBUTING-ru.md

Как помочь проекту

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

Что вам нужно

• Убедитесь что у вас есть Аккаунт GitLab

• Создайте тикет для ваших изменений. Этот шаг опционален, тем не менее я очень его рекомендую. Может показаться что этот шаг необязателен, но в моей практике было довольно много случаев, когда я жалел что пропустил его. Причина может быть любой: автор проекта может отклонить патч из-за того, что он не следует специфическим гайдлайнам, код, который вы дополнили, генерируется автоматическими скриптами, или даже проще простого - вы можете попасть под колёса большого рефакторинга, который автор репозитория давно ведёт в отдельной ветке. Так что... просто спросите, если что-то понадобится.

• Создайте форк этого репозитория на GitLab

• Создайте ветку, унаследовавшись от master в главном репозитории Holywarsoo. Избегайте работы в ветке master напрямую - могут появиться конфликты, вы не сможете подтянуть изменения, Я могу сделать force push коммитов, когда считаю что никто не видит... и т.д.

• Закоммитьте изменения. Если вы в своей мирской жизни решили быть очень хорошим человеком, делайте это так, как описано в "Linux kernel contributing guide" - первая строчка короткая, с описанием изменений, вторая пустая, третья и остальные - полное описание внесённых изменений. Используйте тикет, который вы создали ранее, с хеш-символом перед ним, чтобы GitLab мог соотнести его с тикетом и слинковать вместе. Никогда не знаешь, когда это может пригодиться. Вот так: Implement basic UI. Fixes #1

• Создайте мерж-реквест от своего форка в основной репозиторий Holywarsoo. Подождите пока завершится smoke-build и убедитесь, что он проходит. Теперь моя очередь, я буду следить за мерж-реквестами и регулярно их проверять. Через некоторое время и спустя несколько ревизий, падших жертвой моему занудству мерж-реквест будет слит в мастер и мы все сможем спокойно отправиться спать.

• Отлично, добро пожаловать в клуб!

Примечания

• Тестов пока нет, я планирую их сделать.
• Стиль кода стандартный Android + Kotlin.
• Я не накажу и не подвергну вас остракизму, если ваше изменение что-то сломает. Всё знать не под силу человеку. Этот проект очень нишевый, и любая помощь приветствуется.