#36993: Clarify “N/A - {reason}” usage in PR field in contribution docs
-----------------------------------------+------------------------------
Reporter: JaeHyuckSa | Owner: (none)
Type: Uncategorized | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Keywords: pull_reqeust
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------------
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.)
--
Ticket URL: <https://code.djangoproject.com/ticket/36993>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/0107019d09dde24d-ff8474f8-086a-4c06-982e-b4ad86eaa8ee-000000%40eu-central-1.amazonses.com.
