Посібник зі співпраці
Як зробити внесок у платформу Ring - від вашого першого внеску до становлення основним учасником.
🤝 Ласкаво просимо учасників!
Платформа Ring - це open-source проект, який процвітає завдяки внескам спільноти. Чи виправляєте ви баг, додаєте функцію або покращуєте документацію - ваші внески цінуються та вітаються.
🚀 Початок роботи
1. Форк та клонування
Форкнути репозиторій на GitHub Потім клонувати ваш форк Додати upstream remote
git clone https://github.com/YOUR_USERNAME/ring.git
cd ring
git remote add upstream https://github.com/connectplatform/ring.git
2. Налаштування середовища розробки
Встановити залежності Скопіювати шаблон змінних середовища Запустити сервер розробки
npm install
cp env.local.template .env.local
npm run dev
3. Створити гілку функції
Створити гілку з develop
git checkout develop
git pull upstream develop
git checkout -b feature/your-feature-name
📝 Типи внесків
🐛 Звіти про баги
Перш ніж створювати звіт про баг, будь ласка:
- Перевірити існуючі issues
- Використати шаблон звіту про баг
- Включити кроки відтворення
- Надати інформацію про систему
✨ Запити на функції
Для нових функцій:
- Перевірити існуючі запити на функції
- Обговорити в Discord спочатку для великих функцій
- Використати шаблон запиту на функцію
- Пояснити випадок використання та переваги
📚 Документація
Покращення документації завжди вітаються:
- Виправити опечатки та граматику
- Додати відсутні приклади
- Покращити ясність та структуру
- Додати переклади
🔧 Кодові внески
Невеликі зміни
- Виправлення багів
- Покращення продуктивності
- Очищення коду
- Додавання тестів
Великі зміни
- Нові функції
- Breaking changes
- Модифікації архітектури
- Зміни API
[!IMPORTANT]
Обговорюйте великі зміни в GitHub Issues або Discord перед початком роботи.
📋 Настанови розробки
Стандарти якості коду
Перед комітом переконайтеся:
npm run lint # ESLint проходить
npm run type-check # TypeScript компілюється
npm run test # Тести проходять
npm run build # Продакшн збірка успішна
Конвенція комітів
Ми використовуємо Conventional Commits:
feat: додати систему аутентифікації користувачів
bash
fix: вирішити тайм-аут підключення гаманця
docs: оновити документацію API
style: виправити форматування коду
refactor: спростити логіку створення сутностей
test: додати unit тести для можливостей
chore: оновити залежності
Процес Pull Request
1. Створити якісний PR
- Написати ясний заголовок та опис
- Посилатися на пов'язані issues
- Включити скріншоти для змін UI
- Додати тести для нової функціональності
- Оновити документацію
2. Шаблон PR
Опис # Тип зміни # Тестування # Скріншоти # Контрольний список
Короткий опис змін
- [ ] Виправлення бага
- [ ] Нова функція
- [ ] Breaking change
- [ ] Оновлення документації
- [ ] Unit тести додані/оновлені
- [ ] Інтеграційні тести проходять
- [ ] Ручне тестування завершено
(Якщо застосовується)
- [ ] Код відповідає стилістичним настановам
- [ ] Самоперевірка завершена
- [ ] Документація оновлена
- [ ] Немає breaking changes (або задокументовано)
3. Процес перевірки
- Автоматизовані перевірки запускаються (CI/CD)
- Код-рев'ю від maintainers
- Врахувати відгуки
- Схвалення та мердж
🏆 Визнання
Рівні учасників
Учасник спільноти
- Учасники вперше
- Періодичні учасники
- Репортери багів та покращувачі документації
Регулярний учасник
- Кілька мерджнутих PR
- Послідовні якісні внески
- Допомагає іншим учасникам
Основний учасник
- Значні внески у функції
- Участь у код-рев'ю
- Лідерство спільноти
- Тріаж та управління issues
Програма визнання
- Сторінка учасників - Всі учасники перелічені
- Release notes - Згадуються основні учасники
- Discord ролі - Спеціальні ролі учасників
- Swag програма - Футболки та наклейки для активних учасників
📞 Отримання допомоги
Канали спілкування
💬 Discord спільнота
- #contributors - Загальні обговорення учасників
- #development - Технічні питання розробки
- #design - Обговорення UI/UX
- #documentation - Покращення документації
📧 Прямий контакт
Програма менторства
Нові учасники можуть запросити менторство:
- Приєднатися до Discord та представитися в #contributors
- Згадати, що шукаєте менторства
- Основний учасник проведе вас через перший внесок
📜 Кодекс поведінки
Платформа Ring дотримується Contributor Covenant Кодексу поведінки. Беручи участь, ви погоджуєтеся дотримуватися цього кодексу.
Наші стандарти
- Будьте поважними - Ставтеся до всіх з повагою
- Будьте інклюзивними - Вітайте людей усіх походжень
- Будьте конструктивними - Надавайте корисні відгуки
- Будьте collaborative - Працюйте разом заради спільних цілей
Застосування
Порушення кодексу поведінки можна повідомити на conduct@ring.ck.ua. Всі звіти будуть оброблені конфіденційно.
🎯 Ідеї внесків
Good First Issues
Шукайте issues з міткою good-first-issue:
- Покращення документації
- Невеликі виправлення багів
- Додавання тестів
- UI полірування
Help Wanted
Issues з міткою help-wanted потребують допомоги спільноти:
- Реалізації функцій
- Складні виправлення багів
- Оптимізації продуктивності
- Покращення доступності
Дякуємо за внесок у платформу Ring! Разом ми будуємо майбутнє професійного нетворкінгу. 🚀