Вклад в KnowStreaming

Добро пожаловать! Этот документ представляет собой руководство по внесению вклада в проект KnowStreaming.

Если вы обнаружите какие-либо ошибки или упущения, пожалуйста, оставьте свои комментарии или предложения.

Кодекс поведения

Пожалуйста, ознакомьтесь с нашим кодексом поведения [CODE_OF_CONDUCT.md].

Вклад

KnowStreaming приветствует новых участников из любой роли, включая User, Contributor, Committer и PMC.

Мы поощряем новичков активно участвовать в проекте KnowStreaming, начиная с роли User и продвигаясь до Contributor, Committer и даже PMC.

Чтобы достичь этого, новички должны активно вносить свой вклад в проект KnowStreaming. Ниже приведены инструкции о том, как внести свой вклад в KnowStreaming.

Создание/открытие Issue

Если вы обнаружили орфографическую ошибку в документации, ошибку в коде, хотите предложить новую функцию или дать совет, вы можете создать Issue на GitHub.

Если вы хотите напрямую внести свой вклад, вы можете выбрать следующие вопросы с тегами:

• contribution welcome: для важных и срочных задач.
• good first issue: подходит для новичков, чтобы они могли попрактиковаться.

Обратите внимание, что любой PR должен быть связан с актуальным Issue. В противном случае PR будет отклонён.

Начало вашего вклада

Введение в ветки

Мы используем ветку dev как ветку разработки, которая является нестабильной веткой.

Кроме того, наша модель ветвления соответствует https://nvie.com/posts/a-successful-git-branching-model/. Мы настоятельно рекомендуем новичкам прочитать эту статью перед созданием PR.

Процесс вклада

Для удобства описания мы определяем два термина здесь:

Ваш собственный форкнутый репозиторий — это личный репозиторий, который мы называем «форкнутый репозиторий». Форкнутый исходный проект мы называем «исходным репозиторием».

Теперь, если вы готовы создать PR, вот рабочий процесс для вкладчиков:

1. Форкните проект KnowStreaming в свой собственный репозиторий.

2. Извлеките и создайте свою локальную ветку из исходного репозитория dev, например: dev.

3. Внесите изменения в код в вашей локальной ветке.

4. Перебазируйте ветку разработки и разрешите конфликты.

5. Зафиксируйте и отправьте ваши изменения в ваш собственный форкнутый репозиторий.

6. Создайте Pull Request в ветке dev исходного репозитория.

7. Дождитесь ответа. Если ответ задерживается, не стесняйтесь напоминать.

Более подробный процесс вклада см. в: [Процесс вклада](./docs/contributer_guide/Процесс вклада.md).

При создании Pull Request:

1. Следуйте шаблону PR шаблон.
2. Убедитесь, что PR связан с соответствующим Issue.
3. Если ваш PR включает значительные изменения, такие как перестройка компонентов или новые компоненты, напишите подробную документацию о его дизайне и использовании (в соответствующем Issue).
4. Обратите внимание, что один PR не должен быть слишком большим. Если необходимо внести много изменений, лучше разделить их на несколько отдельных PR.
5. Перед объединением PR постарайтесь сделать окончательную фиксацию ясной и краткой, объединив несколько изменений в одну фиксацию, насколько это возможно.
6. После создания PR назначьте одного или нескольких рецензентов для PR.

Если ваш PR включает существенные изменения, такие как перестроение компонентов или новые компоненты, предоставьте подробную документацию об их дизайне и использовании.

Руководство по проверке кода

Commiter будет последовательно проверять код, чтобы гарантировать, что по крайней мере один Commiter проверяет код перед объединением.

Некоторые принципы:

• Читаемость — важный код должен иметь подробную документацию. API должен иметь Javadoc. Стиль кода должен соответствовать существующему стилю.
• Элегантность — новые функции, классы или компоненты должны быть хорошо спроектированы.
• Тестируемость — тестовые случаи юнит-тестов должны покрывать 80% нового кода.
• Удобство сопровождения — соблюдайте наши стандарты кодирования.

Разработчик

Стать Contributor

Просто успешно отправьте и объедините PR, и вы станете Contributor.

Список вкладчиков см.: [Список разработчиков](./docs/contributer_guide/Список разработчиков.md)

Попытка стать Commiter

Как правило, внесите 8 важных исправлений и позвольте как минимум трём разным людям проверить их (вам потребуется поддержка трёх Committer). Затем попросите кого-нибудь выдвинуть вашу кандидатуру. Вам нужно продемонстрировать:

1. Как минимум 8 важных PR и связанные с ними проблемы проекта.
2. Способность сотрудничать с командой.
3. Понимание кодовой базы и стиля кодирования проекта.
4. Навыки написания хорошего кода.

Текущие Committer могут выдвигать кандидатов через Issue-теги KnowStreaming nomination (выдвижение). Пожалуйста, укажите:

1. Ваше имя и фамилию.
2. Ссылка на вашу личную информацию Git.
3. Объясните, почему вы должны стать Committer.
4. Подробно опишите три PR выдвижения и соответствующие проблемы, которые могут подтвердить ваши способности.

Два других Committer должны поддержать ваше выдвижение, и если в течение пяти рабочих дней никто не возражает, вы становитесь Committer. Если есть возражения или требуется дополнительная информация, Committer обсудит и обычно достигнет консенсуса (в течение пяти рабочих дней).

Программа поощрения открытого исходного кода

Мы очень приветствуем разработчиков, вносящих свой вклад в открытый исходный код проекта KnowStreaming, и предоставим им стимулы для признания и благодарности.

Участие во вкладе

1. Активно участвуйте в обсуждении Issue, таких как ответы на вопросы, предоставление идей или сообщение о проблемах, которые невозможно решить (Issue).
2. Написание и улучшение документации проекта (Wiki).
3. Отправка исправлений для оптимизации кода (Coding).

Вы получите

1. Включены в список вкладчиков KnowStreaming и продемонстрированы.
2. Сертификат вкладчика KnowStreaming (бумажный и электронный).
3. Значительный подарочный набор для вкладчиков KnowStreaming (KnowStreamin/DIDI сувениры).

Соответствующие правила

— Contributer и Commiter получат соответствующий сертификат и подарочный набор. — Команда проекта KnowStreaming выбирает выдающихся вкладчиков каждый квартал и вручает соответствующие сертификаты. — Ежегодный отбор проводится в конце года.

Список участников см.: [Список участников](./docs/contributer_guide/Список участников.md)