[Django] #21609: CONTRIBUTING.rst contradicts the contributing guidelines
Django
-------------------------------+--------------------
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------
The Django documentation gives contradictory guidance on how to submit a
trivial doc fix. `CONTRIBUTING.rst` says:
Warning: pull requests are ignored! File a ticket to suggest changes.
... Patches can be submitted as pull requests, but if you don't file a
ticket, it's unlikely that we'll notice your contribution.
However, [https://docs.djangoproject.com/en/dev/internals/contributing
/writing-code/submitting-patches/#typo-fixes-and-trivial-documentation-
changes Submitting patches] says,
If you are fixing a really trivial issue, for example changing a word in
the documentation, the preferred way to provide the patch is using GitHub
pull requests without a Trac ticket.
--
Ticket URL: <https://code.djangoproject.com/ticket/21609>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by bmispelon):
* needs_docs: => 0
* needs_better_patch: => 0
* needs_tests: => 0
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:1>
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by cjerdonek):
* cc: cjerdonek (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:2>
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by aaugustin):
I'm the author of [7db4c81d] which added that text in CONTRIBUTING.rst.
I would be very happy if someone explained to me what process guarantees
that PRs for typos won't get ignored and then lost among our hundreds of
open pull requests.
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:3>
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by mjtamlyn):
I think at present there is no particular process which *guarantees* that
PRs of that nature won't get ignored potentially indefinitely, however
with at least myself, Tim and Alex relatively following github
notifications for Django, I know many trivial patches have been committed
that way. As a note, by trivial here I mean easy typos (spelling mistakes
and the like) rather than anything which needs checking out. If I can
commit it without needing to do anything other than reading the diff, then
I will do so directly via github. Otherwise the trac flow is useful.
In summary, there's no concrete process for this, but it does happen
anyway. In any case, the documents should be specific. My personal opinion
is that trac tickets for correcting simple spelling mistakes are overkill
and they shouldn't be necessary.
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:4>
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by cjerdonek):
The current wording of `CONTRIBUTING.rst` implies that pull requests are
guaranteed to be ignored, which isn't true either. (By the way, I think
that meant to say "pull requests without tickets" are ignored.) Maybe the
compromise wording can say that pull requests for trivial doc fixes are
okay, but that if the pull request hasn't been acknowledged or acted upon
within a certain amount of time (e.g. a week or two), then the submitter
can file a ticket pointing to the pull request.
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:5>
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by aaugustin):
I'd say a day or two, but otherwise, yes, this is correct. Pull request
(referencing this ticket) welcome!
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:6>
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Comment (by cjerdonek):
I'd say a day or two, but otherwise, yes, this is correct. Pull request
(referencing this ticket) welcome!
Okay, I can create one.
@mjtamlyn, because you follow the github notifications with Tim and Alex,
what do you think is the right amount of time to wait for people like you
three to address a trivial doc fix before filing a ticket?
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:7>
Django
Reporter: cjerdonek | Owner: nobody
Type: Bug | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"d430f1d98b564543d1c90d067efdf1ee6851d8d3"]:
{{{
#!CommitTicketReference repository=""
revision="d430f1d98b564543d1c90d067efdf1ee6851d8d3"
Fixed #21609 -- Amended CONTRIBUTING.rst pull request guidelines.
Thanks cjerdonek for the suggestion.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/21609#comment:8>