Вклад в uftrace

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

https://github.com/namhyung/uftrace

Стиль кодирования

Uftrace написан на языке C и в основном следует стилю кодирования ядра Linux [1]. Единственное отличие заключается в том, где поставить закрывающую скобку и начало последующего блока. Я предпочитаю ставить их на отдельной строке для удобства чтения. Например:

if (cond == A) {
	do_some_thing();
}
else if (cond == B) {
	do_other_thing();
}

Обратите внимание на позицию строки «else if».

Для программ на Python (для тестов или скриптов) используйте 4 пробела для отступа.

[1] https://www.kernel.org/doc/Documentation/process/coding-style.rst

Включите ключевое слово в заголовок сообщения

Хотя у uftrace небольшая кодовая база, я считаю, что хорошей практикой является добавление двоеточия перед ключевым словом в строке темы. Это позволяет мне и другим разработчикам легче отличать патчи от других тем.

$ git log --oneline --graph

• fef4226 Merge branch 'misc-fix' |
  | * 54a4ef0 test: Fix to be able to call runtest.py directly | * 6bbe4a0 graph: Skip kernel functions outside of user | * a76c7cb kernel: Use real address for filter match |/ ...

Подписание вашего патча

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

Сертификат разработчика происхождения 1.1

Делая вклад в этот проект, я подтверждаю, что:

(а) Вклад был создан полностью или частично мной, и я имею право представить его под лицензией с открытым исходным кодом, указанной в файле; или

(б) Вклад основан на предыдущей работе, которая, насколько мне известно, подпадает под соответствующую лицензию с открытым исходным кодом, и у меня есть право в соответствии с этой лицензией представить эту работу с изменениями, будь то созданная полностью или частично мною, под той же лицензией с открытым исходным кодом (если только мне не разрешено представлять её под другой лицензией), как указано в файле; или

(в) Вклад был предоставлен непосредственно мне каким-либо другим лицом, которое подтвердило (а), (б) или (в), и я не вносил в него изменений.

(г) Я понимаю и соглашаюсь с тем, что этот проект и вклад являются публичными, и что запись о вкладе (включая всю личную информацию, которую я предоставляю вместе с ним, включая мою подпись) ведётся бессрочно и может быть распространена в соответствии с этим проектом или задействованными лицензиями с открытым исходным кодом.

Тогда вы просто добавляете строку, говорящую:

Signed-off-by: Random J Developer random@developer.example.org

используя ваше настоящее имя (извините, никаких псевдонимов или анонимных вкладов).