#26708: Updates to the "Writing your first patch for Django" Documentation Page
-------------------------------------+-------------------------------------
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:
> 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
New description:
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#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/062.8236eed5887b2ccd4a42771bc722da35%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
