[1.9.x] Corrected outdated information in submitting patches guide.
Backport of 101dbeb673
from master
This commit is contained in:
parent
5856f15e68
commit
e30040dd93
|
@ -11,7 +11,7 @@ Typo fixes and trivial documentation changes
|
||||||
|
|
||||||
If you are fixing a really trivial issue, for example changing a word in the
|
If you are fixing a really trivial issue, for example changing a word in the
|
||||||
documentation, the preferred way to provide the patch is using GitHub pull
|
documentation, the preferred way to provide the patch is using GitHub pull
|
||||||
requests without a Trac ticket. Trac tickets are still acceptable.
|
requests without a Trac ticket.
|
||||||
|
|
||||||
See the :doc:`working-with-git` for more details on how to use pull requests.
|
See the :doc:`working-with-git` for more details on how to use pull requests.
|
||||||
|
|
||||||
|
@ -29,9 +29,9 @@ If you have identified a contribution you want to make and you're capable of
|
||||||
fixing it (as measured by your coding ability, knowledge of Django internals
|
fixing it (as measured by your coding ability, knowledge of Django internals
|
||||||
and time availability), claim it by following these steps:
|
and time availability), claim it by following these steps:
|
||||||
|
|
||||||
* `Create an account`_ to use in our ticket system. If you have an account
|
* `Login using your GitHub account`_ or `create an account`_ in our ticket
|
||||||
but have forgotten your password, you can reset it using the
|
system. If you have an account but have forgotten your password, you can
|
||||||
`password reset page`_.
|
reset it using the `password reset page`_.
|
||||||
|
|
||||||
* If a ticket for this issue doesn't exist yet, create one in our
|
* If a ticket for this issue doesn't exist yet, create one in our
|
||||||
`ticket tracker`_.
|
`ticket tracker`_.
|
||||||
|
@ -39,18 +39,16 @@ and time availability), claim it by following these steps:
|
||||||
* If a ticket for this issue already exists, make sure nobody else has
|
* If a ticket for this issue already exists, make sure nobody else has
|
||||||
claimed it. To do this, look at the "Owned by" section of the ticket.
|
claimed it. To do this, look at the "Owned by" section of the ticket.
|
||||||
If it's assigned to "nobody," then it's available to be claimed.
|
If it's assigned to "nobody," then it's available to be claimed.
|
||||||
Otherwise, somebody else is working on this ticket, and you either find
|
Otherwise, somebody else may be working on this ticket. Either find another
|
||||||
another bug/feature to work on, or contact the developer working on the
|
bug/feature to work on, or contact the developer working on the ticket to
|
||||||
ticket to offer your help.
|
offer your help. If a ticket has been assigned for weeks or months without
|
||||||
|
any activity, it's probably safe to reassign it to yourself.
|
||||||
|
|
||||||
* Log into your account, if you haven't already, by clicking "Login" in
|
* Log into your account, if you haven't already, by clicking "GitHub Login"
|
||||||
the upper right of the ticket page.
|
or "DjangoProject Login" in the upper left of the ticket page.
|
||||||
|
|
||||||
* Claim the ticket:
|
* Claim the ticket by clicking the "assign to myself" radio button under
|
||||||
|
"Action" near the bottom of the page, then click "Submit changes."
|
||||||
1. click the "assign to myself" radio button under "Action" near the bottom of the
|
|
||||||
page,
|
|
||||||
2. then click "Submit changes."
|
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The Django software foundation requests that anyone contributing more than
|
The Django software foundation requests that anyone contributing more than
|
||||||
|
@ -58,6 +56,7 @@ and time availability), claim it by following these steps:
|
||||||
Agreement`_, this ensures that the Django Software Foundation has clear
|
Agreement`_, this ensures that the Django Software Foundation has clear
|
||||||
license to all contributions allowing for a clear license for all users.
|
license to all contributions allowing for a clear license for all users.
|
||||||
|
|
||||||
|
.. _Login using your GitHub account: https://code.djangoproject.com/github/login
|
||||||
.. _Create an account: https://www.djangoproject.com/accounts/register/
|
.. _Create an account: https://www.djangoproject.com/accounts/register/
|
||||||
.. _password reset page: https://www.djangoproject.com/accounts/password/reset/
|
.. _password reset page: https://www.djangoproject.com/accounts/password/reset/
|
||||||
.. _Contributor License Agreement: https://www.djangoproject.com/foundation/cla/
|
.. _Contributor License Agreement: https://www.djangoproject.com/foundation/cla/
|
||||||
|
@ -114,21 +113,14 @@ requirements:
|
||||||
behavior of an existing feature, the patch should also contain
|
behavior of an existing feature, the patch should also contain
|
||||||
documentation.
|
documentation.
|
||||||
|
|
||||||
You can use either GitHub branches and pull requests or direct patches
|
When you think your work is ready to be reviewed, send :doc:`a GitHub pull
|
||||||
to publish your work. If you use the Git workflow, then you should
|
request <working-with-git>`. Please review the patch yourself using our
|
||||||
announce your branch in the ticket by including a link to your branch.
|
:ref:`patch review checklist <patch-review-checklist>` first.
|
||||||
When you think your work is ready to be merged in create a pull request.
|
|
||||||
|
|
||||||
See the :doc:`working-with-git` documentation for more details.
|
If you can't send a pull request for some reason, you can also use patches in
|
||||||
|
Trac. When using this style, follow these guidelines.
|
||||||
You can also use patches in Trac. When using this style, follow these
|
|
||||||
guidelines.
|
|
||||||
|
|
||||||
* Submit patches in the format returned by the ``git diff`` command.
|
* Submit patches in the format returned by the ``git diff`` command.
|
||||||
An exception is for code changes that are described more clearly in
|
|
||||||
plain English than in code. Indentation is the most common example; it's
|
|
||||||
hard to read patches when the only difference in code is that it's
|
|
||||||
indented.
|
|
||||||
|
|
||||||
* Attach patches to a ticket in the `ticket tracker`_, using the "attach
|
* Attach patches to a ticket in the `ticket tracker`_, using the "attach
|
||||||
file" button. Please *don't* put the patch in the ticket description
|
file" button. Please *don't* put the patch in the ticket description
|
||||||
|
@ -139,14 +131,16 @@ guidelines.
|
||||||
|
|
||||||
Regardless of the way you submit your work, follow these steps.
|
Regardless of the way you submit your work, follow these steps.
|
||||||
|
|
||||||
* Make sure your code matches our :doc:`coding-style`.
|
* Make sure your code fulfills the requirements in our :ref:`patch review
|
||||||
|
checklist <patch-review-checklist>`.
|
||||||
|
|
||||||
* Check the "Has patch" box on the ticket details. This will make it
|
* Check the "Has patch" box on the ticket and make sure the "Needs
|
||||||
obvious that the ticket includes a patch, and it will add the ticket to
|
documentation", "Needs tests", and "Patch needs improvement" boxes aren't
|
||||||
the `list of tickets with patches`_.
|
checked. This makes the ticket appear in the "Patches needing review" queue
|
||||||
|
on the `Development dashboard`_.
|
||||||
|
|
||||||
.. _list of tickets with patches: https://code.djangoproject.com/query?status=new&status=assigned&status=reopened&has_patch=1&order=priority
|
|
||||||
.. _ticket tracker: https://code.djangoproject.com/newticket
|
.. _ticket tracker: https://code.djangoproject.com/newticket
|
||||||
|
.. _Development dashboard: https://dashboard.djangoproject.com/
|
||||||
|
|
||||||
Non-trivial patches
|
Non-trivial patches
|
||||||
-------------------
|
-------------------
|
||||||
|
|
Loading…
Reference in New Issue