[Django] #26708: Updates to the "Writing your first patch for Django" Documentation Page
Django
--------------------------------------+--------------------
Reporter: nnja | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+--------------------
While this section is helpful, it should be updated to reflect a git-
oriented and not patch-based workflow. Once these changes are made, it can
also be featured as a 'Quick Start' to contributing section, and featured
in the 'First Steps' portion of the contribution guide.
The following workflow should be represented in the document:
1. Fork the project, Then Clone your fork
2. Running Tests (Link To
https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/unit-tests/)
3. Create a Branch
4. Modify the Code / Documentation
5. Diff your changes with Upstream
6. Commit - (Link to Coding Style / Commit Guidelines Here)
7. Push to your branch
8. Create a Pull Request
** Links to more detailed documentation for the steps above should be
provided where needed.
Additionally, the following needs to be done:
- Prominently Link to the Git Workflow, near the top.
(https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/working-with-git/)
- Change the title to 'Quick Start Guide to Contributing'
- Remove all References to 'Patch', including in links to this document
from other places
- Rewrite the 'So What do I do next Section?'
-Remove the `Since we never committed our changes locally` section, since
in the new workflow we *did* commit our changes locally.
- Add a link to the document under the 'First Steps' section of the
Contribution Guide
--
Ticket URL: <https://code.djangoproject.com/ticket/26708>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: nnja | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by nnja):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Old description:
New description:
--
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:1>
Django
Reporter: nnja | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Description changed by nnja:
Old description:
New description:
- Remove the 'Since we never committed our changes locally' section, since
in the new workflow we *did* commit our changes locally.
- Add a link to the document under the 'First Steps' section of the
Contribution Guide
--
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:2>
Django
Reporter: nnja | Owner: nnja
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by nnja):
* owner: nobody => nnja
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:3>
Django
Reporter: nnja | Owner: nnja
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by MarkusH):
* cc: MarkusH (added)
* needs_better_patch: 0 => 1
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:4>
Django
--------------------------------------+------------------------------------
Reporter: nnja | Owner: nnja
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timgraham):
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:5>
Django
--------------------------------------+------------------------------------
Reporter: nnja | Owner: nnja
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Remco47):
I'd like to fix this ticket as part of the django sprint, but which page
is it talking about, specifically?
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:6>
Django
--------------------------------------+------------------------------------
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Remco47):
* owner: nnja => Remco47
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:7>
Django
Reporter: nnja | Owner:
Type: | deltaskelta
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by deltaskelta):
* owner: nobody => deltaskelta
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: nnja | Owner:
Type: | deltaskelta
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by deltaskelta):
Just to make sure I understand, It looks like:
1. The majority of the documentation that needs to be fixed is in the
contributing/writing_code and contributing/committing_code sections,
2. Removing all references to patches. I'm assuming the proper substitute
would be the word "pull request" with the proper verb for the sentence?
Everything else seems to be clearly stated, but I just want to verify that
#1 would be the sections where the bulk of the reorganizing needs to take
place.
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: nnja | Owner:
Type: | deltaskelta
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by timgraham):
The contributing tutorial is `docs/intro/contributing.txt`.
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:8>
Django
Reporter: Nina Zakharenko | Owner: za
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by za):
* owner: Jeff Willette => za
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:9>
Django
--------------------------------------+------------------------------------
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by za):
* owner: za => (none)
* status: assigned => new
Comment:
Note: There is working-with-git documentation exist:
https://docs.djangoproject.com/en/1.10/internals/contributing/writing-code
/working-with-git/
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:10>
Django
--------------------------------------+------------------------------------
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Song Jin):
* owner: (none) => Song Jin
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:11>
Django
Reporter: Nina Zakharenko | Owner: Abhishek
Type: | Bera
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Abhishek Bera):
* owner: (none) => Abhishek Bera
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:9>
Django
Reporter: Nina Zakharenko | Owner: (none)
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Abhishek Bera):
* owner: Abhishek Bera => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:10>
Django
Reporter: Nina Zakharenko | Owner:
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Subhrajyoti Sen):
* owner: (none) => Subhrajyoti Sen
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:11>
Django
-------------------------------------+-------------------------------------
Reporter: Nina Zakharenko | Owner:
Type: | Subhrajyoti Sen
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Subhrajyoti Sen):
Do all the pages with reference to 'patches' needed to modified or only
docs/intro/contributing.txt ?
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:12>
Django
-------------------------------------+-------------------------------------
Reporter: Nina Zakharenko | Owner:
Type: | Subhrajyoti Sen
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham):
Using the word "patch" is not inappropriate.
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:13>
Django
-------------------------------------+-------------------------------------
Reporter: Nina Zakharenko | Owner:
Type: | Subhrajyoti Sen
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"f5bf11c72b267d717dd4379ec80f9f7c5185f80f" f5bf11c7]:
{{{
#!CommitTicketReference repository=""
revision="f5bf11c72b267d717dd4379ec80f9f7c5185f80f"
Fixed #26708 -- Updated the contributing tutorial to use a GitHub
workflow.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:14>
Django
-------------------------------------+-------------------------------------
Reporter: Nina Zakharenko | Owner:
Type: | Subhrajyoti Sen
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"a52b223f74eab7a6ddaa855c2ad30fde4cdf397a" a52b223]:
{{{
#!CommitTicketReference repository=""
revision="a52b223f74eab7a6ddaa855c2ad30fde4cdf397a"
[1.10.x] Fixed #26708 -- Updated the contributing tutorial to use a GitHub
workflow.
Backport of f5bf11c72b267d717dd4379ec80f9f7c5185f80f from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:15>
Django
-------------------------------------+-------------------------------------
Reporter: Nina Zakharenko | Owner:
Type: | Subhrajyoti Sen
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"b183abfc8d09ecc1ee4ace4e0c6d11bd9d42b2fb" b183abf]:
{{{
#!CommitTicketReference repository=""
revision="b183abfc8d09ecc1ee4ace4e0c6d11bd9d42b2fb"
[1.11.x] Fixed #26708 -- Updated the contributing tutorial to use a GitHub
workflow.
Backport of f5bf11c72b267d717dd4379ec80f9f7c5185f80f from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/26708#comment:16>