Opened 4 weeks ago

Closed 3 weeks ago

#36993 closed Cleanup/optimization (fixed)

Clarify “N/A - typo” usage in PR field in contribution docs

Reported by: JaeHyuckSa Owned by: JaeHyuckSa
Component: Documentation Version: dev
Severity: Normal Keywords: pull_request
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

Hello!

Currently, Django requires most pull requests to reference a Trac ticket, and this is somewhat enforced through the contribution guidelines.

However, in practice, for low-risk PRs such as typo fixes, documentation updates, and small test additions, proceeding without a ticket under a “no ticket” approach is also encouraged in the guidelines.

Through a recent discussion on the [Django Forum](https://forum.djangoproject.com/t/introduce-a-minor-tag-for-low-risk-prs-that-dont-need-a-trac-ticket/44561/9), it seemed appropriate to make this intent more explicit by allowing contributors to write a reason in the ticket field when a PR is intentionally ticketless, such as:

  • N/A - typo
  • N/A - docs
  • N/A - tests

With this in mind, I would like to suggest that we first explicitly document this pattern in the pull request template and related documentation.

(While it may be possible to validate guideline compliance later using GitHub Actions or similar approaches, I think it would be better to first establish a clear workflow standard through documentation and templates.)

Change History (7)

comment:1 by JaeHyuckSa, 4 weeks ago

Owner: set to JaeHyuckSa

comment:2 by siri_dasari, 4 weeks ago

Hi, I would like to work on this issue.
I plan to update the contribution documentation to clarify the use of "N/A - {reason}" in PRs without tickets.

comment:3 by Jacob Walls, 4 weeks ago

Keywords: pull_request added; pull_reqeust removed
Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

Happy to look at a patch here. I think our stance is that only typo-fixes go through without a ticket. Sometimes we're a little loose about enforcing it, but once we have automation for this, it will be a lot easier to enforce. So let's not change the policy; let's just fix the PR template to be more specific.

Hi, I would like to work on this issue.

The author already assigned it to themselves.

comment:4 by Jacob Walls, 4 weeks ago

Summary: Clarify “N/A - {reason}” usage in PR field in contribution docsClarify “N/A - typo” usage in PR field in contribution docs

comment:5 by JaeHyuckSa, 4 weeks ago

Has patch: set

comment:6 by Jacob Walls, 3 weeks ago

Triage Stage: AcceptedReady for checkin

comment:7 by Jacob Walls <jacobtylerwalls@…>, 3 weeks ago

Resolution: fixed
Status: assignedclosed

In f6167b8:

Fixed #36993 -- Clarified N/A usage in pull request template for typo fixes.

Signed-off-by: JaeHyuckSa <jaehyuck.sa.dev@…>

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