Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (73 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

97 lines (73 loc) · 3.49 KB

Вклад в проект Auto Poster Bot

Спасибо за интерес к проекту! Мы приветствуем любой вклад в развитие Auto Poster Bot.

🚀 Как внести вклад

1. Сообщить об ошибке

  • Используйте Issues для сообщения об ошибках
  • Опишите проблему максимально подробно
  • Приложите логи и скриншоты, если возможно

2. Предложить улучшение

  • Создайте Issue с тегом enhancement
  • Опишите предлагаемую функциональность
  • Объясните, почему это будет полезно

3. Внести код

  1. Сделайте Fork репозитория
  2. Создайте ветку для вашей функции (git checkout -b feature/amazing-feature)
  3. Внесите изменения
  4. Добавьте тесты, если необходимо
  5. Убедитесь, что код соответствует стилю проекта
  6. Сделайте коммит (git commit -m 'Add amazing feature')
  7. Отправьте в ветку (git push origin feature/amazing-feature)
  8. Создайте Pull Request

📋 Правила разработки

Стиль кода

  • Python: Следуйте PEP 8, используйте black для форматирования
  • TypeScript/React: Используйте ESLint и Prettier
  • Коммиты: Используйте Conventional Commits

Тестирование

  • Добавляйте тесты для новой функциональности
  • Убедитесь, что все существующие тесты проходят
  • Покрытие кода должно быть не менее 80%

Документация

  • Обновляйте README.md при необходимости
  • Добавляйте docstrings для новых функций
  • Комментируйте сложную логику

🔧 Настройка среды разработки

# Клонируйте ваш fork
git clone https://github.com/your-username/auto-poster-bot.git
cd auto-poster-bot

# Установите зависимости
docker-compose up -d postgres redis

# Backend
cd backend
pip install -r requirements.txt
python -m pytest

# Frontend
cd ../frontend
npm install
npm test

📝 Шаблон Pull Request

## Описание
Краткое описание изменений

## Тип изменения
- [ ] Исправление ошибки
- [ ] Новая функция
- [ ] Критическое изменение
- [ ] Обновление документации

## Тестирование
- [ ] Тесты проходят локально
- [ ] Добавлены новые тесты
- [ ] Обновлена документация

## Скриншоты (если применимо)

🤝 Сообщество

  • Будьте уважительны к другим участникам
  • Помогайте новичкам
  • Следуйте Code of Conduct

📞 Связь

  • GitHub Issues для багов и предложений
  • Discussions для общих вопросов
  • Email: [ваш-email] для приватных вопросов

Спасибо за ваш вклад! 🎉