Update the contributing tutorial to use GitHub workflow
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:
- Fork the project, Then Clone your fork
- Running Tests (Link To https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/)
- Create a Branch
- Modify the Code / Documentation
- Diff your changes with Upstream
- Commit - (Link to Coding Style / Commit Guidelines Here)
- Push to your branch
- 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)
| Description: |
modified (diff)
|
| Description: |
modified (diff)
|
| Cc: |
Markus Holtermann added
|
| Patch needs improvement: |
set
|
| Triage Stage: |
Unreviewed → Accepted
|
| Patch needs improvement: |
unset
|
| Summary: |
Updates to the "Writing your first patch for Django" Documentation Page → Update the contributing tutorial to use GitHub workflow
|
| Owner: |
set to Abhishek Bera
|
| Status: |
new → assigned
|
| Owner: |
Abhishek Bera removed
|
| Status: |
assigned → new
|
| Owner: |
set to Subhrajyoti Sen
|
| Status: |
new → assigned
|
| Resolution: |
→ fixed
|
| Status: |
assigned → closed
|
Just to make sure I understand, It looks like:
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.