Opened 3 months ago

Closed 13 days ago

Last modified 13 days ago

#37111 closed Cleanup/optimization (fixed)

Add a sprints quickstart guide for contributors

Reported by: Tim Schilling Owned by: Tim Schilling
Component: Documentation Version: dev
Severity: Normal Keywords: contributing, documentation
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

At the PyCon US 2026 sprints, Natalia, Jacob and I were referring to the same resources, processes and workflows, but lacked a singular place to send people to. There appears to be a need for a page to exist in the contribution docs for contribution sprint events. When people have access to an existing Django contributor, there's less of a need to read the contribution guidelines in full and more of a push to get the person productive.

This new page should contain a concise set of information that the Django contributor can send people to so that when they explain in person, there's a written version for the new contributor to refer back to.

The topics we should cover are:

  • Quick set up for installing dependencies
  • Show how to run tests, build docs
  • Explain vulture method
  • Give quick tips on assessing issues (>20000, pick a component they recognize)
  • Give script to resume work off of someone else's branch

Change History (10)

comment:1 by Tim Schilling, 3 months ago

The proposed changes can be found here. It's a rough first draft. I feel like the topics covered are good and would argue to keep them. I'm happy to see the details updated.

comment:2 by Natalia Bidart, 3 months ago

Triage Stage: UnreviewedAccepted

comment:3 by Tim Schilling, 3 months ago

Has patch: set

comment:4 by Tim Schilling, 2 months ago

Patch needs improvement: set

comment:5 by Tim Schilling, 2 months ago

Patch needs improvement: unset

comment:6 by Jacob Walls, 5 weeks ago

Patch needs improvement: set

Smart to include the vulture query! I just left a suggestion to use natural language timestamps so that we can freeze the link.

comment:7 by Natalia Bidart, 13 days ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:8 by nessita <124304+nessita@…>, 13 days ago

Resolution: fixed
Status: assignedclosed

In 143a65c:

Fixed #37111 -- Added sprints quickstart docs page.

Added a documentation page that contains a concise set of guidelines to
help new contributors be more effective at sprints or other events with
in-person Django contributors.

Included a pair of links on how to filter down tickets, which calls out
adding the additional columns and filtering to docs components, and a
internal reference link for django-docker-box.

Thanks Annabelle Wiegart, Natalia Bidart, Paolo Melchiorre, Jacob Walls,
and Tim Mccurrachd for reviews.

Co-authored-by: tim-mccurrach <34194722+tim-mccurrach@…>
Co-authored-by: nessita <124304+nessita@…>

comment:9 by Natalia <124304+nessita@…>, 13 days ago

In a9aaa88:

[6.1.x] Fixed #37111 -- Added sprints quickstart docs page.

Added a documentation page that contains a concise set of guidelines to
help new contributors be more effective at sprints or other events with
in-person Django contributors.

Included a pair of links on how to filter down tickets, which calls out
adding the additional columns and filtering to docs components, and a
internal reference link for django-docker-box.

Thanks Annabelle Wiegart, Natalia Bidart, Paolo Melchiorre, Jacob Walls,
and Tim Mccurrachd for reviews.

Backport of 143a65ca92b8e8d8bc692c52b27605378369ee00 from main.

Co-authored-by: tim-mccurrach <34194722+tim-mccurrach@…>
Co-authored-by: nessita <124304+nessita@…>

comment:10 by Natalia <124304+nessita@…>, 13 days ago

In 457d178f:

[6.0.x] Fixed #37111 -- Added sprints quickstart docs page.

Added a documentation page that contains a concise set of guidelines to
help new contributors be more effective at sprints or other events with
in-person Django contributors.

Included a pair of links on how to filter down tickets, which calls out
adding the additional columns and filtering to docs components, and a
internal reference link for django-docker-box.

Thanks Annabelle Wiegart, Natalia Bidart, Paolo Melchiorre, Jacob Walls,
and Tim Mccurrachd for reviews.

Backport of 143a65ca92b8e8d8bc692c52b27605378369ee00 from main.

Co-authored-by: tim-mccurrach <34194722+tim-mccurrach@…>
Co-authored-by: nessita <124304+nessita@…>

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