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