English | Русский

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

Спасибо за ваше внимание и поддержку AimRT!

Мы рады любым формам вклада, включая, но не ограничиваясь, созданием issue, предоставлением предложений по улучшению, улучшением документации, исправлением ошибок и добавлением функций. Данный документ предназначен для предоставления подробного руководства по вкладу, чтобы помочь вам лучше участвовать в проекте. Перед вкладом внимательно ознакомьтесь с этим руководством и убедитесь, что вы следуете здесь установленным правилам. Мы с нетерпением ждем возможности работать вместе с вами, чтобы сделать этот проект еще лучше!

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

Проект приветствует патчи кода, но чтобы гарантировать, что все хорошо согласовано, вы должны обсудить любые значительные изменения перед тем, как начать работу. Рекомендуется указать ваши намерения вклада в issue-трекере, что можно сделать, либо заявившись на существующее issue, либо создав новое issue.

Просмотр issue-трекера

Независимо от того, знаете ли вы уже, какие вклады вы хотите сделать, или ищете идеи, issue-трекер всегда является вашим первым местом. Issues классифицируются для управления рабочим процессом.

Большинство issues помечены одним из следующих рабочих процессов:- NeedsInvestigation: проблема еще не полностью понята, требуются исследования для понимания причины.

• NeedsDecision: проблема хорошо понята, но команда AimRT еще не приняла решение о наилучшем способе решения проблемы. Лучше подождать решения перед написанием кода. Если решение не принято в течение некоторого времени и вы заинтересованы в обработке проблемы в таком состоянии, вы можете "ping" поддержку в комментариях проблемы.
• NeedsFix: проблема полностью понята, можно написать код для исправления.

Открытие проблемы для любого нового вопроса

Кроме очень мелких изменений, все вклады должны быть связаны с существующими проблемами. Пожалуйста, откройте проблему и обсудите свои планы. Этот процесс позволяет каждому иметь возможность проверить дизайн, что помогает предотвратить дублирование работы и убедиться, что идеи соответствуют целям языка и инструментов. Перед написанием кода можно также проверить, является ли дизайн разумным; инструменты для проверки кода не предназначены для высокого уровня обсуждения.

При создании проблемы убедитесь, что вы ответили на следующие пять вопросов:

1. Какой версией AimRT вы пользуетесь?
2. Какой операционной системой и компилятором вы пользуетесь?
3. Что вы сделали?
4. Что вы ожидали увидеть?
5. Что вы действительно увидели?

Вклад кода

Следуйте GitHub процессу для создания GitHub PR (Pull Request).Пожалуйста, имейте в виду следующие моменты:

• Убедитесь, что ваш код соответствует стандартам кодирования проекта. Это включает, но не ограничивается, стилем кода и стандартами комментариев. Это помогает нам поддерживать чистоту и согласованность проекта. Самое базовое, вы можете запустить ./format.sh в корневой директории проекта для форматирования.
• Перед отправкой PR убедитесь, что вы протестировали свой код локально. Убедитесь, что код работает правильно (с помощью ./test.sh).
• Чтобы использовать новые изменения для обновления pull request, просто добавьте их в ветку; вы можете добавить дополнительные коммиты, или выполнить rebase и force-push (оба стиля допустимы).
• Если ваш запрос будет принят, все коммиты будут сжаты, и финальный коммит будет содержать описание из заголовка и описания PR. Описание отдельных коммитов будет удалено. Обратитесь к разделу "Написание хороших сообщений коммитов" для получения рекомендаций.

Написание хороших сообщений коммитов

Сообщения коммитов в AimRT следуют определённым соглашениям, которые мы обсудим в этом разделе.

Вот пример хорошего сообщения:

math: улучшение точности Sin, Cos и Tan для очень больших аргументов

Существующая реализация имеет плохие числовые свойства для больших аргументов, поэтому используется алгоритм McGillicutty для улучшения точности выше 1e10.

Алгоритм описан на https://wikipedia.org/wiki/McGillicutty_Algorithm

Fixes #159#### Первая строка

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

Опытным правилом является то, что оно должно быть написано в виде завершённого предложения "This change modifies AimRT to _____." Это означает, что оно не начинается с заглавной буквы, не является полным предложением и действительно кратко описывает результат изменений.

После первой строки оставьте пустую строку.

Основное содержание

Оставшаяся часть описания должна быть подробной и предоставлять контекст для изменений и объяснять их действие. Как и в комментариях AimRT, используйте правильные знаки препинания для полных предложений. Не используйте HTML, Markdown или любую другую разметку. Добавьте любую дополнительную информацию, например, если изменения влияют на производительность, добавьте данные о производительности.

Ссылка на issue

Специальное обозначение "Fixes #12345" связывает изменения с issue #12345 в системе отслеживания задач AimRT. Когда это изменение будет применено, система отслеживания задач автоматически отметит issue как закрытый.

Заявление о правах

Файлы в репозитории AimRT не содержат указания на авторов, чтобы избежать путаницы и необходимости постоянного обновления списка. Ваше имя будет указано в журнале изменений.Новые файлы, которые вы добавляете, должны содержать стандартное заявление о правах:

// Copyright (c) 2024 The AimRT Authors.
// AimRT использует лицензию Mulan PSL v2.

Файлы в репозитории при добавлении защищены авторским правом, год добавления указан в заявлении о правах. При изменении файлов не обновляйте год в заявлении о правах.