Посібник щодо внесків¶
Існує безліч способів зробити свій внесок у BeeWare. У цих посібниках ви знайдете всю необхідну інформацію для того, щоб зробити свій внесок.
Використання штучного інтелекту та автономних інструментів
Проєкт BeeWare не заохочує і не забороняє використання інструментів штучного інтелекту під час внесення внесків. Однак, якщо ви все ж використовуєте такий інструмент, ми вимагаємо, щоб ви вказали, які саме інструменти ви використовували. У нашій Політиці щодо штучного інтелекту міститься повна інформація про ваші зобов’язання.
Що мені робити?¶
Виправити проблему¶
Найпростіший спосіб допомогти — це написати код для виправлення відомої проблеми.
Реалізувати нову функцію¶
Чи бракує в BeeWare функції, яку ви хотіли б бачити? Ви можете реалізувати нову функцію.
Створити документацію¶
Жодна функція не вважається завершеною, доки вона не буде належним чином задокументована. Написання документації — це спосіб зробити свій внесок, який не передбачає написання коду.
Оцінка проблеми¶
Щоразу, коли хтось повідомляє про нову проблему, її необхідно проаналізувати. Аналіз проблеми передбачає вивчення інформації, наданої автором повідомлення, та спробу відтворити описану ним проблему.
Переглянути запит на злиття¶
Після надсилання запиту на злиття його необхідно перевірити, перш ніж його можна буде об’єднати. Незалежно від того, чи добре ви знайомі з його змістом, ймовірно, ви зможете допомогти з перевіркою запиту на злиття.
Запропонувати нову функцію¶
Чи є у вас пропозиція або ідея щодо нового доповнення до одного з інструментів BeeWare? Ви можете запропонувати нову функцію для розгляду.
Перекласти вміст¶
BeeWare веде документацію різними мовами. Якщо ви володієте якоюсь мовою, окрім англійської, ви можете допомогти з перекладом матеріалів.
Скористайтеся інструментами¶
У вас є ідея щодо створення додатка на базі Toga? Або у вас вже є додаток, який можна інтегрувати з Briefcase? Ви можете скористатися інструментами та поділитися своїми враженнями.
Як я можу долучитися?¶
Налаштування середовища розробки¶
Перш ніж почати робити внески в BeeWare, вам потрібно налаштувати своє середовище розробки.
Відтворити проблему¶
Перш ніж виправити проблему, вам потрібно перевірити її наявність. Відтворення проблеми також є важливою частиною процесу сортування.
Робота з гілки¶
Готуючись до надсилання внеску, завжди працюйте у гілці.
Уникайте розширення обсягу робіт¶
Важливо зберігати зосередженість і уникати розширення обсягу робіт під час роботи над вашим внеском.
Запропонувати нову функцію¶
Щоб запропонувати нову функцію, виконайте наведені нижче кроки.
Написати, запустити та протестувати код¶
Щоб оновити код або внести свій внесок, вам потрібно написати, запустити та протестувати свій код.
Створити документацію¶
Щоб оновлювати документацію або долучатися до її створення, вам потрібно мати можливість згенерувати документацію.
Створити документацію¶
Щоб долучитися до створення документації, вам потрібно написати новий матеріал або оновити існуючий.
Додати примітку про зміну¶
Кожен запит на злиття повинен супроводжуватися поясненням змін.
Надіслати запит на злиття¶
Як тільки ваші зміни будуть готові, ви надішлете запит на злиття для перевірки.
Написати відгук¶
Якщо вам зручно, ви можете залишити відгук про чийсь внесок.
Перекласти вміст¶
BeeWare використовує Weblate для перекладів, і для початку роботи з ним потрібно виконати кілька кроків.
Повідомити про нову проблему¶
Якщо ви зіткнетеся з новою проблемою або помилкою, буде корисно повідомити про неї.
Що буде далі?¶
Перевірка запиту на злиття¶
Після надсилання запиту на злиття наступним кроком є перевірка PR.
Процес випуску¶
Об’єднані зміни пройдуть процес випуску.
Політики¶
Політика щодо штучного інтелекту¶
Політика BeeWare щодо використання генеративного ШІ, великих мовних моделей та інших автономних інструментів під час внесення матеріалів.
Керівництва зі стилю¶
Керівництво зі стилю написання коду¶
Ось рекомендації щодо внесення коду в проекти BeeWare.
Керівництво зі стилю документації¶
Ось рекомендації щодо внесення документації до проектів BeeWare.