Советы для новых участников

Новый участник, и вы не знаете, что делать? Хотите помочь, но не знаете, с чего начать? Этот раздел для вас.

Основные инструменты и рабочий процесс

Если вы новичок в работе с Django, руководство « Написание первого патча Django» дает вам введение в инструменты и рабочий процесс.

Первые шаги

Начните с этих шагов, чтобы узнать о процессе разработки Django.

  • Сортировать билеты

    Если заявка со статусом непросмотренная сообщает об аномалии, попробуйте воспроизвести ее. Если у вас все получилось, и, следовательно, проблема кажется реальной, напишите записку о том, что вы смогли подтвердить аномалию и принять билет. Убедитесь, что билет классифицируется по правильному компоненту («Компонент»). Рассмотрите возможность написания патча, который добавляет тест на проблемное поведение, даже если вы не исправляете саму ошибку. Узнайте больше на странице Как я могу помочь в сортировке билетов? ,

  • Найдите принятые билеты и сделайте обзор исправлений, чтобы ознакомиться с кодовой базой и процессами

    Установите соответствующие флажки, если исправление требует документации или тестирования. Просмотрите изменения, внесенные исправлением, и помните о синтаксисе, который может быть несовместим с все еще поддерживаемыми версиями Python. : doc: Запустите тесты </ internals / Participing / writing-code / unit-tests> и убедитесь, что они проходят. По возможности и при необходимости запускайте их с базой данных, отличной от SQLite. Напишите свои комментарии и впечатления!

  • Обновляйте старые патчи

    Часто база кода изменяется между моментом отправки патча и временем его проверки. Убедитесь, что он по-прежнему работает правильно и работает должным образом. Обновление исправления полезно и важно! Подробнее на странице отправки патчей .

  • Напишите документацию

    Документация Django выполнена хорошо, но всегда есть возможности для улучшения. Вы нашли орфографическую ошибку? Как вы думаете, нужно что-то уточнить? Придумайте исправление для документации! См. Также руководство по написанию документации .

    Заметка

    На странице "Отчеты" есть ссылки на множество полезных запросов Trac, в том числе некоторые из них, посвященные сортировке заявок и проверке исправлений, как предложено выше.

  • Подпишите лицензионное соглашение на участие

    Код, который вы пишете, принадлежит вам или вашему работодателю. Если ваш вклад превышает одну или две строки кода, вы должны подписать CLA . См. FAQ по лицензионному соглашению для получения более полного объяснения.

Рекомендации

Новичок в большом проекте легко может разочароваться. Вот несколько советов, которые помогут сделать ваш вклад в Django максимально полезным и полезным.

  • Выберите тему, которая вам близка, знакома вам или о которой вы хотите узнать больше

    Вам не обязательно быть экспертом в той области, в которой вы хотите работать; мы постепенно становимся таковыми из-за кодовых вкладов.

  • Анализируйте контекст и историю билетов

    Страх сцены не абсолютен; контекст так же важен, как и слова. Читая Trac, вы должны учитывать, кто говорит и когда это было написано. Поддержка идеи двухлетней давности не обязательно означает, что идея все еще поддерживается. Также следует учитывать, кто не говорил. Например, если опытный участник в последнее время не участвовал в обсуждении, проблема, о которой идет речь, может еще не иметь необходимой поддержки для ее применения в Django.

  • Начни с малого

    Получить отзывы по мелким вопросам легче, чем по более крупным темам. Просматривайте билеты, отмеченные как легкие .

  • Если вы собираетесь приступить к большой задаче, сначала убедитесь, что ваша идея пользуется поддержкой.

    Это означает, что кому-то еще нужно подтвердить, что ошибка существует, прежде чем приступить к исправлению ошибки, и убедиться, что существует консенсус по предлагаемой функции, прежде чем приступить к ее реализации. ,

  • Быть храбрым ! Напишите свой опыт!

    Иногда может показаться пугающим публично высказать свое мнение и сказать «это правильное решение» или «это исправление необходимо переработать», но это единственный способ продвинуть проект вперед. Вклад более широкого сообщества Django в конечном итоге имеет гораздо большее влияние, чем то, что мог бы сделать один человек. Без тебя мы не справимся !

  • Будьте осторожны, прежде чем отмечать билет как «Готовый к регистрации».

    Если вы не уверены, готов ли билет, не отмечайте его как таковой. Вместо этого напишите комментарий, чтобы сообщить другим ваше мнение. Если вы уверены, но не совсем уверены, вы также можете задать вопрос в IRC, чтобы узнать, может ли кто-нибудь подтвердить вашу идею.

  • Дождитесь возврата и ответьте на полученное

    Сосредоточьтесь на одном или двух билетах и ​​выполните их от начала до конца, а затем двигайтесь дальше. Огнестрельный подход - начать работать с большим количеством билетов, а затем отложить некоторые в сторону, приносит больше вреда, чем пользы.

  • Быть строгим

    Когда мы говорим " PEP 8 , и у него должны быть документы и тесты », - мы имеем в виду. Если в патче нет документации и тестов, лучше на то есть веская причина. Аргументы вроде «Мне не удалось найти никаких существующих тестов этой функции» не имеют большого значения - хотя это может быть правдой, это означает, что у вас есть очень важная работа по написанию самых первых тестов для этой функции, а не то, что вы полностью отказаться от написания тестов.

FAQ

  1. Этот билет, который мне близок, игнорировался в течение дней / недель / месяцев! Что я могу сделать, чтобы привлечь внимание?

    Во-первых, это не личное. Django полностью разрабатывается добровольцами (за исключением товарища по Django), и иногда у людей просто нет времени. Лучше всего отправить легкое напоминание в список рассылки django-developers с просьбой пересмотреть заявку или опубликовать ее в канале #django-dev IRC.

  2. Я уверен, что мой билет абсолютно на 100% идеален, могу ли я сам пометить его как RFC (готов к фиксации)?

    Короткий ответ: нет. Всегда лучше, чтобы на билет смотрела другая пара глаз. Если вам не удается получить вторую пару глаз, перечитайте вопрос 1 выше.

Copyright ©2021 All rights reserved