четверг, 7 июня 2012 г.

Разработка ядра Python: Как подтвердить патч?

Как я уже говорил, я старался найти что-то,что я мог бы исправить в Python и сообщить об этом. Пока я писал другую статью, я столкнулся с маленькой ошибкой в Windows разделе руководства по разработке. Хотя исправлять документацию не так прикольно, тем не менее  решил, что для меня это наиболее подходящая для меня область (я в последнее время как раз в основном занимаюсь документацией). Так что я опишу вам этот процесс.

Начало

Во первых Вам понадобится аккаунт на Баг-трекере Python. Если Вы хотите стать одним из разработчиков ядра, то Вам придётся следовать их правилам для имени аккаунта. Правила очень просты:

firstname.lastname
После того, как Вы получите аккаунт, Вы можете начать искать, что бы исправить. Тут есть ссылка "Лёгкие проблемы", что является хорошим местом для начала. Кроме того, Вы можете поискать тот компонент, который Вы хорошо знаете и посмотреть, есть ли в нём ошибки, которые Вы можете исправить. Как только найдёте - Вам остаётся убедиться, что у Вас последняя версия кода Python и прочитать страницу про патчи в руководстве для разработчиков.

Создаём патч

Предположим, что у Вас есть необходимый репозиторий на вашей машине и теперь Вам надо отредактировать соответствующий файл. В моём случае мне надо было проверить руководство для разработчика (с которым Вы можете ознакомиться тут) и отредактировать файл setup.rst. Если Вы редактируете код Python, то Вам следует руководствоваться PEP8. После того, как я закончил редактировать файл,  сохранил мои изменения и затем воспользовался Mercurial для создания патча. Вот команда, которую я использовал для этого:

hg diff > setup.patch
А вот то, что содержится в этом файле с патчем:

diff -r b1c1d15271c0 setup.rst
--- a/setup.rst Tue May 22 00:33:42 2012 +0200
+++ b/setup.rst Tue May 22 13:55:09 2012 -0500
@@ -173,7 +173,7 @@
To build from the Visual Studio GUI, open pcbuild.sln to load the project
files and choose the Build Solution option from the Build menu, often
associated with the F7 key. Make sure you have chosen the "Debug" option from
-the build configuration drop-down first.
+the configuration toolbar drop-down first.

Once built you might want to set Python as a startup project. Pressing F5 in
Visual Studio, or choosing Start Debugging from the Debug menu, will launch

теперь нам осталось лишь подтвердить патч!

Подтверждение патча

Поднимаем щиты - мы отправляемся. Подтверждение патча может быть немного пугающим. Что о Вас подумают люди? На мой взгляд, если Вы собираетесь работать над чем-то значимым, Вам лучше уже сейчас начать отращивать кожу потолще. В моём случае, так как я весго лишь хочу исправить маленькую опечатку, я надеюсь, что это не вызовет волну праведного гнева. С другой стороны, это мой первый патч, так что я мог подтвердить его неправильным образом. Так как мой патч касался по видимому чего-то нового, я сделал быстрый поиск чтобы убедиться, что никто до меня этой ошибки не заметил. Ничего не найдя, я с трепетом нажал на ссылку "создать новую" и выбрал в качестве раздела "руководство разработчика" и новую версию Python (хотя в на трекере это поле пусто). Я не видел ничего, что говорило бы, что это руководство касается какой-то конкретной версии, так что я оставил всё как есть. Подходящего типа я не нашёл, так что это поле я оставил пустым. И, наконец, я прикрепил мой патч. Результат Вы можете видеть тут.
Когда Вы отправляете патч в Python, Вы должны заполнить форму принятия условий вклада , что позволит PSF лицензировать ваш код для использования в Python, так как Вы получаете свой копирайт. Да, Вы тоже можете стать известным просто написав код для Python! Я надеюсь, что люди всё же читают исходники (где указан копирайт) или страницы благодарности.

Итого

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

Комментариев нет:

Отправить комментарий