Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (55 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 3 KB

🤝 Как внести вклад в проект

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

🐛 Сообщить об ошибке

  1. Проверь, что ошибка еще не была зарегистрирована
  2. Создай новый Issue с подробным описанием:
    • Что ты делал
    • Что ожидал получить
    • Что получил на самом деле
    • Скриншоты (если возможно)

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

  1. Открой Discussion
  2. Опиши свою идею подробно
  3. Объясни, как это поможет пользователям

🔧 Внести изменения в код

Быстрый старт для разработчиков:

# Склонируй репозиторий
git clone https://github.com/fedorabakumets/telegram-bot-builder.git
cd telegram-bot-builder

# Установи зависимости
npm install

# Настрой базу данных (PostgreSQL должен быть запущен)
cp .env.example .env
# Отредактируй .env с твоими настройками БД

# Запусти в режиме разработки
npm run dev

Процесс внесения изменений:

  1. Fork репозитория
  2. Создай ветку для своих изменений: git checkout -b feature/amazing-feature
  3. Внеси изменения и протестируй их
  4. Закоммить: git commit -m 'Add amazing feature'
  5. Push в свой fork: git push origin feature/amazing-feature
  6. Создай Pull Request

📋 Стандарты кода

  • Используй TypeScript для типизации
  • Следуй существующему стилю кода
  • Добавляй комментарии для сложной логики
  • Тестируй изменения перед отправкой

🏗️ Архитектура проекта

  • client/ - React frontend
  • server/ - Express backend
  • shared/ - Общие типы и схемы
  • migrations/ - Миграции базы данных

🎯 Приоритетные области для помощи

  1. Новые типы узлов для редактора
  2. Улучшение UI/UX интерфейса
  3. Оптимизация производительности
  4. Документация и примеры
  5. Тестирование на разных платформах

📞 Связь

  • GitHub Issues - для багов и предложений
  • GitHub Discussions - для обсуждений
  • Pull Requests - для изменений кода

Спасибо за помощь в развитии проекта! 🚀