Django2.0手册:Advice for new contributors

New contributor and not sure what to do? Want to help but just don’t know how
to get started? This is the section for you.

Basic tools and workflow

If you are new to contributing to Django, the 编写你的第一个 Django 补丁
tutorial will give you an introduction to the tools and the workflow.

快速入门¶

Start with these easy tasks to discover Django’s development process.

  • Sign the Contributor License Agreement

    The code that you write belongs to you or your employer. If your
    contribution is more than one or two lines of code, you need to sign the
    CLA. See the Contributor License Agreement FAQ for a more thorough
    explanation.

  • Triage tickets

    If an unreviewed ticket reports a bug, try and reproduce it. If you
    can reproduce it and it seems valid, make a note that you confirmed the bug
    and accept the ticket. Make sure the ticket is filed under the correct
    component area. Consider writing a patch that adds a test for the bug’s
    behavior, even if you don’t fix the bug itself. See more at
    How can I help with triaging?

  • Look for tickets that are accepted and review patches to build familiarity
    with the codebase and the process

    Mark the appropriate flags if a patch needs docs or tests. Look through the
    changes a patch makes, and keep an eye out for syntax that is incompatible
    with older but still supported versions of Python. Run the tests and make sure they pass.
    Where possible and relevant, try them out on a database other than SQLite.
    Leave comments and feedback!

  • Keep old patches up to date

    Oftentimes the codebase will change between a patch being submitted and the
    time it gets reviewed. Make sure it still applies cleanly and functions as
    expected. Simply updating a patch is both useful and important! See more on
    Submitting patches.

  • Write some documentation

    Django’s documentation is great but it can always be improved. Did you find
    a typo? Do you think that something should be clarified? Go ahead and
    suggest a documentation patch! See also the guide on
    编写文档.

    Note

    The reports page contains links to many useful Trac queries, including
    several that are useful for triaging tickets and reviewing patches as
    suggested above.

Guidelines¶

As a newcomer on a large project, it’s easy to experience frustration. Here’s
some advice to make your work on Django more useful and rewarding.

  • Pick a subject area that you care about, that you are familiar with, or
    that you want to learn about

    You don’t already have to be an expert on the area you want to work on; you
    become an expert through your ongoing contributions to the code.

  • Analyze tickets’ context and history

    Trac isn’t an absolute; the context is just as important as the words.
    When reading Trac, you need to take into account who says things, and when
    they were said. Support for an idea two years ago doesn’t necessarily mean
    that the idea will still have support. You also need to pay attention to who
    hasn’t spoken — for example, if an experienced contributor hasn’t been
    recently involved in a discussion, then a ticket may not have the support
    required to get into Django.

  • Start small

    It’s easier to get feedback on a little issue than on a big one. See the
    easy pickings.

  • If you’re going to engage in a big task, make sure that your idea has
    support first

    This means getting someone else to confirm that a bug is real before you fix
    the issue, and ensuring that there’s consensus on a proposed feature before
    you go implementing it.

  • Be bold! Leave feedback!

    Sometimes it can be scary to put your opinion out to the world and say “this
    ticket is correct” or “this patch needs work”, but it’s the only way the
    project moves forward. The contributions of the broad Django community
    ultimately have a much greater impact than that of any one person. We can’t
    do it without you!

  • Err on the side of caution when marking things Ready For Check-in

    If you’re really not certain if a ticket is ready, don’t mark it as
    such. Leave a comment instead, letting others know your thoughts. If you’re
    mostly certain, but not completely certain, you might also try asking on IRC
    to see if someone else can confirm your suspicions.

  • Wait for feedback, and respond to feedback that you receive

    Focus on one or two tickets, see them through from start to finish, and
    repeat. The shotgun approach of taking on lots of tickets and letting some
    fall by the wayside ends up doing more harm than good.

  • Be rigorous

    When we say “PEP 8, and must have docs and tests”, we mean it. If a patch
    doesn’t have docs and tests, there had better be a good reason. Arguments
    like “I couldn’t find any existing tests of this feature” don’t carry much
    weight–while it may be true, that means you have the extra-important job of
    writing the very first tests for that feature, not that you get a pass from
    writing tests altogether.

FAQ¶

  1. This ticket I care about has been ignored for days/weeks/months! What can
    I do to get it committed?

    First off, it’s not personal. Django is entirely developed by volunteers
    (except the Django fellow), and sometimes folks just don’t have time. The
    best thing to do is to send a gentle reminder to the django-developers
    mailing list asking for review on the ticket, or to bring it up in the
    #django-dev IRC channel.

  2. I’m sure my ticket is absolutely 100% perfect, can I mark it as RFC
    myself?

    Short answer: No. It’s always better to get another set of eyes on a
    ticket. If you’re having trouble getting that second set of eyes, see
    question 1, above.