diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d80f55..19e71a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,44 +4,43 @@ Contributing to [Dev-vlab] Как начать - 1. Форк: Сделайте форк репозитория, чтобы получить копию проекта в свой аккаунт. - 2. Клонирование: Клонируйте форкнутый репозиторий на свой локальный компьютер. + 1. Форк: Сделайте форк репозитория, чтобы получить копию проекта в свой аккаунт. + 2. Клонирование: Клонируйте форкнутый репозиторий на свой локальный компьютер. ``` git clone https://github.com/your-username/repo-name.git ``` - 3. Создание ветки: Создайте новую ветку для вашего изменения. + 3. Создание ветки: Создайте новую ветку для вашего изменения. ``` git checkout -b feature/название-фичи ``` - 4. Внесение изменений: Внесите необходимые изменения и сделайте коммит. + 4. Внесение изменений: Внесите необходимые изменения и сделайте коммит. ``` git add . git commit -m "Описание ваших изменений" ``` - 5. Пулл-реквест: Отправьте пулл-реквест через GitHub. + 5. Пулл-реквест: Отправьте пулл-реквест через GitHub. Руководство по стилю - • Следуйте существующему стилю кода и архитектуре проекта. - • Убедитесь, что ваш код хорошо документирован. - • Пишите тесты для новых функций или изменений. + • Следуйте существующему стилю кода и архитектуре проекта. + • Убедитесь, что ваш код хорошо документирован. + • Пишите тесты для новых функций или изменений. Отправка PR (Pull Request) - • Убедитесь, что ваш код чистый и без ошибок. - • Проверьте, что все тесты проходят. - • Опишите изменения, которые вы внесли, в заголовке и описании PR. - • Присылайте PR только на ветку main или другую соответствующую ветку. + • Убедитесь, что ваш код чистый и без ошибок. + • Проверьте, что все тесты проходят. + • Опишите изменения, которые вы внесли, в заголовке и описании PR. + • Присылайте PR только на ветку main или другую соответствующую ветку. Сообщение об ошибках Если вы нашли баг, пожалуйста, создайте issue на GitHub и постарайтесь предоставить как можно больше информации: - - • Версия проекта. - • Шаги для воспроизведения. - • Ожидаемое поведение и фактическое поведение. - • Вложите снимки экрана или логи, если это возможно. + • Версия проекта. + • Шаги для воспроизведения. + • Ожидаемое поведение и фактическое поведение. + • Вложите снимки экрана или логи, если это возможно. Связь