Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#26708 closed Cleanup/optimization (fixed)

Update the contributing tutorial to use GitHub workflow

Reported by: Nina Zakharenko Owned by: Subhrajyoti Sen
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 (14)

comment:1 by Nina Zakharenko, 8 years ago

Description: modified (diff)

comment:2 by Nina Zakharenko, 8 years ago

Description: modified (diff)

comment:4 by Markus Holtermann, 8 years ago

Cc: Markus Holtermann added
Patch needs improvement: set
Triage Stage: UnreviewedAccepted

comment:5 by Tim Graham, 8 years ago

Patch needs improvement: unset
Summary: Updates to the "Writing your first patch for Django" Documentation PageUpdate the contributing tutorial to use GitHub workflow

comment:7 by Jeff Willette, 8 years ago

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.

comment:8 by Tim Graham, 8 years ago

The contributing tutorial is docs/intro/contributing.txt.

comment:9 by Abhishek Bera, 8 years ago

Owner: set to Abhishek Bera
Status: newassigned

comment:10 by Abhishek Bera, 8 years ago

Owner: Abhishek Bera removed
Status: assignednew

comment:11 by Subhrajyoti Sen, 8 years ago

Owner: set to Subhrajyoti Sen
Status: newassigned

comment:12 by Subhrajyoti Sen, 8 years ago

What would be the correct alternative to be used for the word "patch"?

Last edited 8 years ago by Subhrajyoti Sen (previous) (diff)

comment:13 by Tim Graham, 8 years ago

Using the word "patch" is not inappropriate.

comment:14 by Tim Graham <timograham@…>, 8 years ago

Resolution: fixed
Status: assignedclosed

In f5bf11c7:

Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow.

comment:15 by Tim Graham <timograham@…>, 8 years ago

In a52b223:

[1.10.x] Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow.

Backport of f5bf11c72b267d717dd4379ec80f9f7c5185f80f from master

comment:16 by Tim Graham <timograham@…>, 8 years ago

In b183abf:

[1.11.x] Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow.

Backport of f5bf11c72b267d717dd4379ec80f9f7c5185f80f from master

Note: See TracTickets for help on using tickets.
Back to Top