Руководство по внесению взносов¶
Есть много способов внести свой вклад в BeeWare. В этих руководствах описано все, что вам нужно знать, чтобы внести свой вклад.
Что я могу сделать?¶
Исправить проблему¶
Самый очевидный вклад, который вы можете внести, — это написать код для исправления известной проблемы.
Внедрить новую функцию¶
В BeeWare отсутствует функция, которую вы хотели бы видеть? Вы можете реализовать новую функцию.
Написать документацию¶
Ни одна функция не считается завершенной, пока она не будет хорошо задокументирована. Написание документации — это способ внести свой вклад, не прибегая к написанию кода.
Сортировка проблемы¶
Каждый раз, когда кто-то сообщает о новой проблеме, она должна пройти сортировку. Сортировка проблемы включает в себя сбор информации, предоставленной сообщающим, и попытку воспроизвести описанную им проблему.
Просмотреть запрос на вытягивание¶
После отправки запроса на слияние он должен быть проверен, прежде чем его можно будет слить. Независимо от того, насколько хорошо вы знакомы с содержанием, вероятно, есть способ, которым вы можете помочь с проверкой запроса на слияние.
Предложить новую функцию¶
У вас есть предложения или идеи по поводу новых функций для одного из инструментов BeeWare? Вы можете предложить новую функцию для рассмотрения.
Перевести контент¶
BeeWare поддерживает различную документацию на нескольких языках. Если вы знаете язык, отличный от английского, вы можете помочь с переводом контента.
Используйте инструменты¶
У вас есть идея для приложения, созданного с помощью Toga? У вас есть существующее приложение, которое можно упаковать с помощью Briefcase? Вы можете использовать инструменты и поделиться своим опытом.
Как я могу внести свой вклад?¶
Настройка среды разработки¶
Прежде чем начать вносить свой вклад в BeeWare, вам необходимо настроить среду разработки.
Воспроизвести проблему¶
Прежде чем исправлять проблему, необходимо убедиться в ее существовании. Воспроизведение проблемы также является важной частью сортировки.
Работа из ветки¶
При подготовке к отправке вклада всегда работайте из ветки.
Избегайте расширения объема работ¶
Важно сохранять концентрацию и избегать расширения сферы деятельности в рамках вашего вклада.
Предложить новую функцию¶
Вы выполните следующие шаги, чтобы предложить новую функцию.
Написание, запуск и тестирование кода¶
Чтобы обновить или добавить код, вам необходимо написать, запустить и протестировать свой код.
Создать документацию¶
Чтобы обновить или дополнить документацию, вам необходимо уметь создавать документы.
Написать документацию¶
Чтобы внести свой вклад в документацию, вам нужно написать новый контент или обновить существующий контент.
Добавить примечание об изменении¶
Каждый запрос на изменение должен сопровождаться примечанием об изменении.
Отправить запрос на извлечение¶
Как только ваши изменения будут готовы, вы отправите запрос на вытягивание для проверки.
Предоставить отзыв¶
Если вам удобно, вы можете оставить отзыв о вкладе другого человека.
Перевести контент¶
BeeWare использует Weblate для переводов, для начала работы с которым необходимо выполнить несколько шагов.
Отправить новую проблему¶
Если вы столкнулись с новой проблемой или ошибкой, полезно отправить сообщение о проблеме.
Что будет дальше?¶
Проверка запроса на извлечение¶
Когда отправлен запрос на вытягивание, следующим шагом является проверка PR.
Процесс выпуска¶
Объединенные вклады пройдут процесс выпуска.
Руководства по стилю¶
Руководство по стилю кода¶
Это руководство по предоставлению кода для проектов BeeWare.
Руководство по стилю документации¶
Это руководство по предоставлению документации для проектов BeeWare.