Вклад в проект MatrixOne

MatrixOne — это проект с открытым исходным кодом, и вы можете внести свой вклад разными способами. Вы можете помочь идеями, кодом или документацией, любые вклады приветствуются.

Спасибо за понимание того, что английский язык используется как общий язык в этом репозитории. Сопровождающие не используют машинный перевод, чтобы избежать недопонимания из-за ошибок перевода. Если описание проблемы / PR написано на неанглийских языках, они могут быть закрыты. Если английский не является вашим родным языком и вы не уверены в чём-то, не стесняйтесь обратиться за помощью в своём запросе на вытягивание!

Какие вклады я могу сделать

Вклады в MatrixOne делятся на следующие категории:

• Чтобы сообщить об ошибке или проблеме с документацией, создайте проблему, предоставив подробную информацию о проблеме. Не забудьте добавить соответствующие метки и следуйте шаблону проблемы.
• Чтобы предложить новую функцию, создайте новый запрос функции проблемы. Опишите предполагаемую функцию и обсудите дизайн и реализацию с командой и сообществом. Как только команда согласится с планом, вы можете следовать рабочему процессу вклада, чтобы реализовать его.
• Чтобы реализовать функцию или исправить ошибку для существующей нерешённой проблемы, следуйте рабочему процессу вклада. Если вам нужен дополнительный контекст по конкретной проблеме, прокомментируйте проблему, чтобы люди знали.

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

Рабочий процесс вклада

1. Сначала полностью прочитайте README.md для настройки среды и инструкций по сборке.
2. Форкните репозиторий на GitHub.
3. Клонируйте свой форк на локальный компьютер с помощью git clone git@github.com:<yourname>/matrixone.git.
4. Создайте ветку с git checkout -b topic-branch, имя ветки зависит от вас.
5. Внесите изменения в свою собственную ветку локально, добавьте необходимые модульные тесты.
6. Вернитесь на GitHub и отправьте запрос на вытягивание, чтобы мы могли рассмотреть ваши изменения. Добавьте некоторые метки, если необходимо, и не забудьте сослаться на связанную проблему.
7. Как только ваш PR будет одобрен, он будет объединён в ближайшее время. Поздравляем.

Не забудьте синхронизировать свой разветвлённый репозиторий перед отправкой предложенных изменений вверх по течению. Если у вас уже есть существующий локальный репозиторий, обновите его перед началом работы, чтобы минимизировать вероятность конфликтов слияния.

git remote add upstream git@github.com:matrixorigin/matrixone.git
git checkout main
git pull upstream main
git checkout -b topic-branch

Если у вас всё ещё есть какие-то проблемы, обратитесь к документам GitHub за помощью.

Проверка кода

Когда вы открываете запрос на вытягивание, вы можете назначить некоторых рецензентов или просто оставить его пустым. И вы можете добавить некоторые связанные метки, чтобы было легче распознать тип/приоритет PR и т. д. Во время проверки рецензенты будут комментировать ваш фрагмент кода, вы сможете изменить код в своей тематической ветке локально, зафиксировать изменения и отправить их на GitHub, новые коммиты будут автоматически прикреплены к PR.

Стиль кода

В MatrixOne используется стиль кодирования, предложенный сообществом Golang. Подробнее см. в документе стиля.

Пожалуйста, придерживайтесь этого стиля, чтобы сделать MatrixOne лёгким для просмотра, поддержки и разработки.