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

Ваш первый pull request

Мы используем GitHub для нашего основного кода. Вы можете начать с чтения Как сделать pull request.

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

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

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

Мы используем git-flow для организации наших веток, также известную как FDD

Проблемы

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

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

2. Доклад о новых проблемах

Предоставление урезанного тестового кода рекомендовано при отчете о проблемах. Это может быть сделано:

• В самом issue
• На Golang Playground

3. Безопасность

Пожалуйста, не сообщайте о безопасных уязвимостях через открытые issues. Обратитесь к нам по email## Как связаться с нами

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

Отправка пулл-запроса

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

1. Поискайте открытый или закрытый PR, связанный с вашей подачей. Вы не хотите дублировать существующие усилия.
2. Вместо того чтобы отправить PR, создайте задачу, если у вас есть лучшая идея по поводу формата инструментов. Мы не принимаем большое количество изменений в файлах без объяснения проблемы и назначения задачи.
3. Убедитесь, что задача описывает проблему, которую вы исправляете, или документирует дизайн для функции, которую вы хотели бы добавить. Перед принятием вашего вклада нам нужно провести проверки и оценки. Поэтому будет лучше, если вы сможете обсудить дизайн с нами.
4. Создайте форк репозитория cloudwego/kitex.
5. В вашем форке, сделайте ваши изменения в новой ветке git:

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

   git push origin my-fix-branch
9. На GitHub отправьте пулл-запрос в kitex:develop с четким и однозначным заголовком. ## Предварительные требования для вклада

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

См. Комментарии к отзыву кода Go.

Хорошие ресурсы:

• Эффективный Go
• Общие рекомендации Pingcap
• Руководство по стилю кода Uber Go