Opened 8 years ago

Last modified 8 years ago

#26708 closed Cleanup/optimization

Updates to the "Writing your first patch for Django" Documentation Page — at Version 2

Reported by: Nina Zakharenko Owned by:
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Markus Holtermann Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description (last modified by Nina Zakharenko)

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

Change History (2)

comment:1 by Nina Zakharenko, 8 years ago

Description: modified (diff)

comment:2 by Nina Zakharenko, 8 years ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top