Opened 4 months ago

Closed 2 months ago

#35546 closed Cleanup/optimization (fixed)

Modernize contributing pages to align with current requirement of having an accepted ticket for non trivial changes

Reported by: Natalia Bidart Owned by: Maryam Yusuf
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Maryam Yusuf 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

Following some feedback from https://github.com/django/django/pull/17389, there are some parts in these docs:

https://docs.djangoproject.com/en/dev/internals/contributing/bugs-and-features/
https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/submitting-patches/

that could benefit from being more explicit about the need to have an accepted ticket when working on non trivial changes.

Specifically, I think that this paragraph is misleading:

"As with most open-source projects, code talks. If you are willing to write the code for the feature yourself or, even better, if you’ve already written it, it’s much more likely to be accepted. Fork Django on GitHub, create a feature branch, and show us your work!"

And also the patch review checklist should explicitly mention that an accepted ticket is required to get reviews/discussion in a GH PR.

Change History (10)

comment:1 by Sarah Boyce, 4 months ago

Triage Stage: UnreviewedAccepted

comment:2 by Amir Karimi, 3 months ago

  1. I think this paragraph "As with most open-source projects, code talks..." is kinda contradictory with what is stated above and can be deleted. I traced its Git history but didn't find out why it was added while there is a lot of emphasis on submitting tickets first.
  2. Obviously, the patch review checklist requires reviews/discussion in its PR, but we can add it to the patch review checklist section.

comment:3 by Maryam Yusuf, 3 months ago

I want to work on this. I have gone through the PR(https://github.com/django/django/pull/17389) to see the feedback. Will assign it to myself and work on it.

comment:4 by Maryam Yusuf, 3 months ago

Owner: changed from nobody to Maryam Yusuf
Status: newassigned

comment:5 by Maryam Yusuf, 3 months ago

Cc: Maryam Yusuf added
Has patch: set

comment:6 by Jacob Walls, 3 months ago

Patch needs improvement: set

comment:7 by Jacob Walls, 3 months ago

Patch needs improvement: unset
Summary: Modernize contributing pages to aling with current requirement of having an accepted ticket for non trivial changesModernize contributing pages to align with current requirement of having an accepted ticket for non trivial changes

comment:8 by Sarah Boyce, 3 months ago

Patch needs improvement: set

comment:9 by Sarah Boyce, 2 months ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:10 by Sarah Boyce <42296566+sarahboyce@…>, 2 months ago

Resolution: fixed
Status: assignedclosed

In 7e00fee3:

Fixed #35546 -- Emphasised accepted ticket requirement in contributing docs.

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