Как внести свой вклад

Ваш первый запрос на включение изменений (Pull Request)

Мы используем GitHub для нашей кодовой базы. Вы можете начать с прочтения статьи «Как сделать запрос на включение изменений» (How To Pull Request).

Без семантического управления версиями

Мы храним стабильный код в ветке main, например golang.org/x. Разработка ведётся на основе ветки develop. И мы обещаем вперёдсовместимость (forward compatibility), добавляя новый каталог пакетов с суффиксом v2/v3, когда код имеет критические изменения.

Организация веток

Мы используем git-flow в качестве организации веток, также известный как FDD (feature-driven development).

Ошибки

1. Как найти известные проблемы

Мы используем GitHub Issues для наших публичных ошибок. Мы внимательно следим за этим и стараемся дать понять, когда у нас идёт внутреннее исправление. Прежде чем создавать новую задачу, попробуйте убедиться, что вашей проблемы ещё не существует.

2. Сообщение о новых проблемах

Рекомендуется предоставлять сокращённый тестовый код для сообщения об ошибках. Его можно разместить: — только в проблемах; — на Golang Playground.

3. Ошибки безопасности

Пожалуйста, не сообщайте об обнаружении ошибок публично. Свяжитесь с нами по электронной почте поддержки.

Как связаться

— Электронная почта.

Отправить запрос на включение изменений

Прежде чем отправить свой запрос на включение изменений (pull request, PR), учтите следующие рекомендации:

1. Выполните поиск на GitHub (GitHub) для открытого или закрытого PR, который относится к вашему запросу. Вы не хотите дублировать существующие усилия.
2. Убедитесь, что проблема описывает проблему, которую вы исправляете, или документирует дизайн функции, которую вы хотели бы добавить. Обсуждение дизайна заранее помогает нам быть готовыми принять вашу работу.
3. Форкните репозиторий cloudwego/netpoll.
4. В вашем разветвлённом репозитории внесите изменения в новой ветке git:

   git checkout -b my-fix-branch develop
5. Создайте патч, включая соответствующие тестовые случаи.
6. Следуйте нашим руководствам по стилю кода.
7. Зафиксируйте изменения, используя описательное сообщение о фиксации, которое соответствует соглашениям об именах сообщений Git Commit Message в AngularJS. Соблюдение этих соглашений необходимо, потому что примечания к выпуску автоматически генерируются из этих сообщений.
8. Отправьте свою ветку на GitHub:

   git push origin my-fix-branch
9. На GitHub отправьте запрос на включение в netpoll:develop.

Необходимые условия для вклада

— Наша среда разработки соответствует Go Official. — Перед отправкой запроса на включение изменений вам необходимо полностью проверить его с помощью инструментов lint. gofmt и golangci-lint. — Вы знакомы с Github. — Возможно, вам нужно ознакомиться с Actions (наш инструмент рабочего процесса по умолчанию).

Руководства по стилю кода

Также см. общие советы Pingcap.

Хорошие ресурсы: — Effective Go. — Комментарии к обзору кода Go. — Руководство Uber по стилю Go.