[Django] #29729: Update "Writing your first patch for Django" tutorial
Django
-------------------------------------------------+------------------------
Reporter: Adam (Chainz) Johnson | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 2.1
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------------------+------------------------
As discussed recently on the django-core-mentorship list (link for those
who can see it: https://groups.google.com/d/msg/django-core-
mentorship/SawVLIt2ntk/MvuwLUaUAwAJ ), there are some test failures now
when following the "Rolling back to a previous revision of Django" section
of this tutorial. The reporter found failures with a new GEOS version (for
an issue fixed on django master a year ago), and I found test failures
with Python 3.7 because the given commit is from Django 1.9.
I suggest two changes:
* Encourage running the test suite on master before hitting this section -
any commit we pick to 'roll back to' is going
* Update to a recent commit and ticket
--
Ticket URL: <https://code.djangoproject.com/ticket/29729>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Type: Uncategorized | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Adam (Chainz) Johnson):
* cc: Adam (Chainz) Johnson (added)
* owner: nobody => Adam (Chainz) Johnson
* status: new => assigned
Comment:
I suspect moving to a later commit isn't a great idea as it'll just be a
moving target. I suggest instead some kind of "fake feature" in the
tutorial to implement, such as adding a new function to django.__init__.
This would also require less knowledge of the specifics of whatever real
tickets are touching, e.g. the current one is a fairly niche forms
feature. Thoughts anyone?
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:1>
Django
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* type: Uncategorized => Bug
* stage: Unreviewed => Accepted
Comment:
The tutorial: [Writing your first patch for Django
https://docs.djangoproject.com/en/2.1/intro/contributing/]
One option would be to provide a pinned set of requirements, so that users
create a virtualenv in a a known state, compatible with the ticket/Django
commit picked.
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:2>
Django
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Type: Bug | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Adam (Chainz) Johnson):
Sure. It would be a lot of requirements though, and other bitrot can still
take place like Python and Pip versions incompatibilities.
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:3>
Django
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Type: Bug | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Carlton Gibson):
Yes, as you say. 🙂
* Happy for you to suggest what you think is best.
* Not sure ‘'anything’’ would survive without maintanence indefinitely.
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Type: Bug | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* has_patch: 0 => 1
* stage: Accepted => Ready for checkin
Comment:
Updating to a more recent commit and ticket is a duplicate of #28034.
[https://github.com/django/django/pull/10363 PR] from Adam for the first
change.
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Component: Documentation | Version: 2.1
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"f8ff529ee32c79b270176f5e8d7a3f6ef048ac31" f8ff529e]:
{{{
#!CommitTicketReference repository=""
revision="f8ff529ee32c79b270176f5e8d7a3f6ef048ac31"
Fixed #29729 -- Updated contributing tutorial to run tests on master.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"2b2474b75d63fcded37b872fcd2bb543d7502a8a" 2b2474b]:
{{{
#!CommitTicketReference repository=""
revision="2b2474b75d63fcded37b872fcd2bb543d7502a8a"
[2.1.x] Fixed #29729 -- Updated contributing tutorial to run tests on
master.
Backport of f8ff529ee32c79b270176f5e8d7a3f6ef048ac31 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: Adam (Chainz) | Owner: Adam
Johnson | (Chainz) Johnson
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Adam (Chainz) Johnson):
Thanks Tim! 🧠
--
Ticket URL: <https://code.djangoproject.com/ticket/29729#comment:8>