Английский | 中文

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

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

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

Перед внесением кода

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

Проверка трекера проблем

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

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

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

Исключая очень простые изменения, все вклады должны быть связаны с существующей проблемой. Не стесняйтесь открыть проблему и обсудить ваши планы. Этот процесс дает всем возможность проверить дизайн, помогает предотвратить дублирование усилий и гарантирует, что идея соответствует целям для языка и инструментов. Он также проверяет, что дизайн надёжен перед написанием кода; инструмент проверки кода не является местом для высокого уровня обсуждений. При создании проблемы убедитесь, что вы ответили на эти пять вопросов:

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

Следуйте GitHub flow для создания GitHub pull request.

Некоторые вещи, которые стоит учесть:

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

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

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

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

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

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

Исправляет #159

Первая строка

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

Правило большого пальца: она должна быть написана так, чтобы завершить предложение "Это изменение модифицирует AimRT для _____." Это значит, что она не начинается с большой буквы, не является полным предложением и действительно резюмирует результат изменений.

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

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

Добавьте любую релевантную информацию, такую как данные бенчмарка, если изменение влияет на производительность.

Ссылки на проблемы

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

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

Новые файлы, которые вы вносите, должны использовать стандартный заголовок авторских прав:

// Copyright (c) 2024 The AimRT Authors.
// AimRT is licensed under Mulan PSL v2.

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