Советы для новых участников¶
Вы новичок и не знаете, что делать? Хотите помочь, но просто не знаетекак начать? Этот раздел для вас.
Включайтесь и работайте!
Если вы хотите сделать свой вклад в развитие Django, Сделайте свой вклад в развитие Django руководство познакомит вас с инструментами и рабочим процессом.
Эта страница содержит более общие советы о том, как вы можете внести свой вклад в Django, и как к этому подойти.
Если вы ищете справочную информацию о деталях внесения изменений в код, см. Написание кода документацию.
Первые шаги¶
Начните с этих шагов, чтобы изучить процесс разработки Django.
Сортировка тикетов¶
Если непросмотренный тикет сообщает об ошибке, попробуйте воспроизвести ее. Если вы можете воспроизвести ее, отметьте, что вы подтвердили ошибку и примите тикет. Убедитесь, что тикет оформлен правильно. Рассмотрите возможность написания патча, который добавляет тест поведения ошибки, даже если вы не исправите саму ошибку. Подробнее см. в Как я могу помочь с сортировкой?
Просмотрите патчи принятых тикетов¶
Это поможет вам познакомиться с кодом и процессами. Отметьте соответствующие флаги, если патч требует документации или тестов. Просмотрите изменения, которые вносит патч, и обратите внимание на синтаксис, несовместимый со старыми, но все еще поддерживаемыми версиями Python. Запустите тесты и убедитесь, что они не валятся. Где это возможно и уместно, попробуйте их на базе данных, отличной от SQLite. Оставляйте комментарии и отзывы!
Поддерживайте старые патчи в актуальном состоянии¶
Часто кодовая база меняется между отправкой патча и временем его проверки. Убедитесь, что он по-прежнему функционирует так, как ожидается. Обновление патча и полезно, и важно! Подробнее см. в Отправка кода.
Пишите документацию¶
Документация Django великолепна, но ее всегда можно улучшить. Вы нашли опечатку? Думаете, что-то следует прояснить? Предложите исправление документации! См. также руководство по Написание документации.
Примечание
Страница отчетов содержит ссылки на множество полезных запросов Trac, включая несколько полезных для сортировки заявок и просмотра исправлений, как предложено выше.
Подпишите лицензионное соглашение участника¶
Код, который вы пишете, принадлежит вам или вашему работодателю. Если ваш вклад составляет более одной или двух строк кода, вам необходимо подписать CLA. Более подробное объяснение см. в Часто задаваемых вопросах о лицензионном соглашении участника.
Руководство¶
Будучи новичком в крупном проекте, легко испытать разочарование. Вот несколько советов, которые сделают вашу работу над Django более полезной и плодотворной.
Выберите предметную область¶
Это должно быть чем-то, что вас волнует, с чем вы знакомы или что вы хотите узнать. Вам не обязательно быть экспертом в области, над которой вы хотите работать; вы становитесь экспертом, постоянно внося вклад в код.
Анализируйте контекст и историю тикетов¶
Trac не истина в последней инстанции; контекст так же важен, как и слова. При чтении Trac, нужно учитывать, кто говорит и когда это было сказано. Поддержка идеи два года назад не обязательно означает, что идея все еще будет иметь поддержку. Вам также нужно обращать внимание на то, кто не высказался — например, если опытный участник не был недавно вовлечен в обсуждение, то тикет может не иметь поддержки, необходимой для реализации в Django.
Начните с малого¶
Легче получить обратную связь по незначительной проблеме, чем по крупной. См. легкую добычу.
Получите поддержку, прежде чем приступать к крупной задаче¶
Это означает, что нужно попросить кого-то еще подтвердить, что ошибка реальна, прежде чем вы исправите проблему, и убедиться, что существует консенсус по предлагаемой функции, прежде чем вы приступите к ее реализации.
Будьте смелее! Оставьте отзыв!¶
Иногда может быть страшно высказать свое мнение миру и сказать: «Этот тикет правильный» или «Этот патч требует доработки», но это единственный способ, которым проект движется вперед. Вклад сообщества Django в конечном итоге имеет гораздо большее влияние, чем вклад любого отдельного человека. Мы не сможем сделать это без вас!
Будьте осторожны, отмечая вещи как «Готово к мерджу.¶
Если вы действительно не уверены, готов ли тикет, не отмечайте его как таковым.Вместо этого оставьте комментарий, расскажите другим о своих мыслях. Если вы в основном уверены, но не полностью, вы также можете попробовать задать вопрос на канале #contributing-getting-started на сервере Django Discord, чтобы посмотреть, сможет ли кто-то еще подтвердить ваши подозрения.
Дождитесь обратной связи и отвечайте на полученные отзывы.¶
Сосредоточьтесь на одном или двух тикетах, просмотрите их от начала до конца и повторите. Метод дробления, при котором берутся за множество тикетов и позволяет некоторым отвалиться, в конечном итоге приносит больше вреда, чем пользы.
Будьте строги¶
Когда мы говорим «PEP 8, и должны иметь документацию и тесты», мы говорим об этом не просто так. Если патч не имеет документации и тестов, то на это должна быть веская причина. Такие аргументы, как «Я не смог найти ни одного существующего теста этой функции», не имеют большого веса. Хотя это может быть правдой, это означает, что у вас есть сверх-важная работа по написанию самых первых тестов для этой функции, а не то, что вы можете не писать тесты вообще.
Будьте терпеливы¶
Не всегда легко быстро рассмотреть ваш тикет или ваш патч.Не принимайте ничего не свой счет. У других участников есть множество тикетов и пул-реквестов.
Важно поддерживать актуальность вашего патча. Просмотрите тикет в Trac, чтобы убедиться, что флаги Needs tests, Needs tests и Needs tests improvements сняты после того, как вы рассмотрите все комментарии по отзывам.
Помните, что цикл выпуска Django составляет восемь месяцев, так что у вас будет достаточно времени для рассмотрения вашего патча.
Наконец, своевременное напоминание может помочь. См. Часто задаваемые вопросы по изменений в код.