Contributing to [Dev-vlab]
Спасибо за ваше желание внести вклад в проект [Название Проекта]! Мы приветствуем любую помощь, будь то исправление ошибок, добавление новых функций или улучшение документации.
Как начать
- Форк: Сделайте форк репозитория, чтобы получить копию проекта в свой аккаунт.
- Клонирование: Клонируйте форкнутый репозиторий на свой локальный компьютер.
git clone https://github.com/your-username/repo-name.git
- Создание ветки: Создайте новую ветку для вашего изменения.
git checkout -b feature/название-фичи
- Внесение изменений: Внесите необходимые изменения и сделайте коммит.
git add .
git commit -m "Описание ваших изменений"
- Пулл-реквест: Отправьте пулл-реквест через GitHub.
Руководство по стилю
• Следуйте существующему стилю кода и архитектуре проекта.
• Убедитесь, что ваш код хорошо документирован.
• Пишите тесты для новых функций или изменений.
Отправка PR (Pull Request)
• Убедитесь, что ваш код чистый и без ошибок.
• Проверьте, что все тесты проходят
• Опишите изменения, которые вы внесли, в заголовке и описании PR.
• Присылайте PR только на ветку main или другую соответствующую ветку.
Сообщение об ошибках
Если вы нашли баг, пожалуйста, создайте issue на GitHub и постарайтесь предоставить как можно больше информации:
• Версия проекта.
• Шаги для воспроизведения.
• Ожидаемое поведение и фактическое поведение.
• Вложите снимки экрана или логи, если это возможно.
Связь
Если у вас есть вопросы или вы хотите обсудить вашу идею перед началом работы, не стесняйтесь создать обсуждение на странице Discussions или связаться через telegram @vistee или по почте.
Спасибо за ваше участие!