Керування вихідним кодом

Проект PX4 використовує модель розгалуження Git із трьома гілками:

• main is by default unstable and sees rapid development.
• beta has been thoroughly tested. Він призначений для тестерів на польоти.
• stable points to the last release.

We try to retain a linear history through rebases and avoid the Github flow. Однак через глобальну команду і швидкий розвиток ми можемо одночасно вдаватися до збоїв.

To contribute new functionality, sign up for Github, then fork the repository, create a new branch, add your changes as commits, and finally send a pull request. Changes will be merged when they pass our continuous integration tests.

All code contributions have to be under the permissive BSD 3-clause license and all code must not impose any further constraints on the use.

Стиль Коду

PX4 uses the Google C++ style guide, with the following (minimal) modifications:

INFO

Not all PX4 source code matches the style guide, but any new code that you write should do so — in both new and existing files. Якщо ви оновлюєте існуючий файл, від вас не вимагається, щоб весь файл відповідав інструкції зі стилю, а лише код, який ви змінили.

Вкладки

• Вкладки використовуються для відступу (еквівалентно 8 пробілу).
• Пробіли використовуються для вирівнювання.

Довжина рядка

• Максимальна довжина рядка становить 120 символів.

Розширення файлів

• Source files use extension *.cpp instead of *.cc.

Іменування функцій та методів

• lowerCamelCase() is used for functions and methods to visually distinguish them from ClassConstructors() and ClassNames.

Імена змінних членів приватного класу

• _underscore_prefixed_snake_case is used for private class member variable names, as oppose to underscore_postfixed_.

Ключові слова класу

• zero spaces before public:, private:, or protected: keywords.

Приклад сніпета коду

class MyClass {
public:

        /**
         * @brief Description of what this function does.
         *
         * @param[in] input_param Clear description of the input [units]
         * @return Whatever we are returning [units]
         */
        float doSomething(const float input_param) const {
                const float in_scope_variable = input_param + kConstantFloat;
                return in_scope_variable * _private_member_variable;
        }

        void setPrivateMember(const float private_member_variable) { _private_member_variable = private_member_variable; }

        /**
         * @return Whatever we are "getting" [units]
         */
        float getPrivateMember() const { return _private_member_variable; }

private:

        // Clear description of the constant if not completely obvious from the name [units]
        static constexpr float kConstantFloat = ...;

        // Clear description of the variable if not completely obvious from the name [units]
        float _private_member_variable{...};
};

Вбудована документація

PX4 розробників заохочують до створення відповідної документації через джерело.

INFO

Стандарти документації вихідного коду не застосовуються, і код в даний час непослідовно документований. Ми б хотіли зробити краще!

В даний час у нас є два типи базової документації:

• PRINT_MODULE_* methods are used for both module run time usage instructions and for the Modules & Commands Reference in this guide.

  • The API is documented in the source code here.
  • Good examples of usage include the Application/Module Template and the files linked from the modules reference.

• We encourage other in-source documentation where it adds value/is not redundant.

  TIP

  Developers should name C++ entities (classes, functions, variables etc.) such that their purpose can be inferred - reducing the need for explicit documentation.

:::

• Не додавати документацію, яку тривіально можна вивести з імен об'єктів С++.
• ЗАВЖДИ вказуйте одиниці змінних, констант і параметрів введення/повернення там, де вони визначені.
• ЗАВЖДИ вказуйте одиниці змінних, постійних і параметрів введення/повернення там, де вони визначені.
• Doxgyen tags should be used if documentation is needed: @class, @file, @param, @return, @brief, @var, @see, @note. A good example of usage is src/modules/events/send_event.h.

Будь ласка, уникайте "магічних чисел", наприклад, звідки прийшло це число? А як щодо множника при введенні ручки повороту?

if (fabsf(yaw_stick_normalized_input) < 0.1f) {
        yaw_rate_setpoint = 0.0f;
}
else {
        yaw_rate_setpoint = 0.52f * yaw_stick_normalized_input;
}

Натомість визначте цифри як константи з відповідним контекстом у заголовку:

// Порогове значення мертвої зони для нормалізованого введення повороту
static constexpr float kYawStickDeadzone = 0.1f;

// [рад/с] Порогове значення мертвої зони для нормалізованого введення повороту
static constexpr float kMaxYawRate = math::radians(30.0f);

і оновіть реалізацію вихідного коду.

if (fabsf(yaw_stick_normalized_input) < kYawStickDeadzone) {
        yaw_rate_setpoint = 0.0f;
}
else {
        yaw_rate_setpoint = kMaxYawRate * yaw_stick_normalized_input;
}

Коміти та повідомлення комітів

Використовуйте описові повідомлення з кількома абзацами для всіх нетривіальних змін. Добре структуруйте їх, щоб вони мали сенс у підсумку в один рядок, але також надавали повну деталізацію.

Component: Explain the change in one sentence. Fixes #1234

Prepend the software component to the start of the summary
line, either by the module name or a description of it.
(e.g. "mc_att_ctrl" or "multicopter attitude controller").

If the issue number is appended as <Fixes #1234>, Github
will automatically close the issue when the commit is
merged to the master branch.

The body of the message can contain several paragraphs.
Describe in detail what you changed. Link issues and flight
logs either related to this fix or to the testing results
of this commit.

Describe the change and why you changed it, avoid to
paraphrase the code change (Good: "Adds an additional
safety check for vehicles with low quality GPS reception".
Bad: "Add gps_reception_check() function").

Reported-by: Name <email@px4.io>

Use git commit -s to sign off on all of your commits. This will add signed-off-by: with your name and email as the last line.

This commit guide is based on best practices for the Linux Kernel and other projects maintained by Linus Torvalds.

Запити на злиття

Github Pull Requests (PRs) are the primary mechanism used to submit new functionality and bug fixes to PX4.

They include the new set of commits in your branch (relative the main branch), and a description of the changes.

Опис повинен включати:

• Огляд того, що доставляють дані зміни; достатньо для розуміння широкої мети коду
• Посилання на пов'язані з питаннями або підтримка інформації.
• Інформація про те як було виконано тестування PR функціональності з посиланнями на журнали польотів.
• Where possible, the results from general Test Flights both before and after the change.