Skip to content

Latest commit

 

History

History
55 lines (30 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

55 lines (30 loc) · 4.54 KB
Raw

Как Внести Вклад в ITB - IT Exchange 🤝

Приветствуем вас в проекте ITB - IT Exchange! Мы рады вашему желанию внести вклад в развитие проекта. Пожалуйста, ознакомьтесь с этими рекомендациями для успешного и эффективного сотрудничества.

Как Начать 🚀

  1. Ознакомьтесь с проектом: Прежде чем вносить изменения, ознакомьтесь с нашей документацией и кодом, чтобы понять архитектуру и логику проекта. 📚

  2. Присоединяйтесь к обсуждениям: Участвуйте в обсуждениях, делитесь своими идеями и предложениями с другими участниками проекта. 💬

  3. Форк и Клонирование: Форкните наш репозиторий и создайте локальную копию на вашем компьютере. Затем создайте новую ветку для ваших изменений. 🛠️

    git clone git@github.com:Abyss-fallers/ITB-FRONTEND.git
cd ITB-FRONTEND
git checkout -b ваша-ветка

  4. Внесите Изменения: Внесите изменения в код или документацию в вашей ветке, следуя нашему стилю кодирования и рекомендациям. ✏️

  5. Тестирование: Убедитесь, что ваши изменения не нарушают существующий функционал. Запустите все тесты и проверьте, что они проходят успешно. ✅

  6. Создайте Pull Request: После завершения изменений и тестирования создайте Pull Request (PR) в основной репозиторий. Опишите в PR, что было изменено и почему. 📥

Руководство по Коду 💻

  • Следуйте Стилю Кодирования: Мы придерживаемся определенных стандартов кодирования. Пожалуйста, ознакомьтесь с нашим Руководством по Стилю Кодирования. 📏

  • Пишите Тесты: Если вы добавляете новый функционал, не забудьте написать соответствующие тесты. Это поможет нам поддерживать высокое качество кода. 🧪

  • Документируйте Изменения: Обновляйте документацию в соответствии с вашими изменениями. Это поможет другим участникам проекта понять ваши нововведения. 📘

Отправка Pull Request 🚀

  1. Проверьте ваши изменения: Убедитесь, что все изменения верны и хорошо протестированы. 🧩

  2. Описывайте ваш PR: Предоставьте четкое и подробное описание ваших изменений в Pull Request. Укажите, что было сделано и почему это важно. ✍️

  3. Сделайте PR чистым: Разделите изменения на логически отдельные коммиты и ветки, чтобы облегчить ревью. 🧹

  4. Следуйте Обратной Связи: Будьте готовы обсуждать ваши изменения и вносить правки по замечаниям рецензентов. 🤔

Как Связаться с Нами 📧

Если у вас есть вопросы или предложения, не стесняйтесь связаться с нами:

Благодарности 🎉

Спасибо, что решили внести свой вклад в наш проект. Мы ценим ваше время и усилия!

Лицензия 📜

Все вкладчики обязуются следовать условиям лицензии, указанной в LICENSE.