Hi
I would like to propose a change to the contribution policy.
The current policy is
Authors: How to get your change reviewed
There must be an issue in the Twisted Github Issue tracker describing
the desired outcome.
This is found in our docs at
https://docs.twisted.org/en/latest/development/review-process.html#authors-how-to-get-your-change-reviewed
I would like to have this rule to allow pull requests without a Github issue
for the following cases:
* typo fixes in docstrings
* changes to documentation
* changes that only affect the automated tests, and which don't change the
production code.
In my opinion, asking for a separate GitHub each time you find a typo, is
just red tape, and discourages small contributions.
With GitHub web UI, you can browse the current code, observe a type, fix
the typo in the web and then send the changes as a PR.
I feel that this is as frictionless as possible.
A PR with a GitHub issue would still need a release note, but the release
notes will have the PR ID, instead of the ticket ID.
-------------
Here is an example of a PR https://github.com/twisted/twisted/pull/12088
that I consider a redtape.
The PR description is just a placeholder `Fixes #12087`
and then on Issue 12087 we have:
Title: BufferingTLSTransport has docstring formatting errors. #12087
Description: see
https://docs.twisted.org/en/stable/api/twisted.protocols.tls.BufferingTLSTransport.html
I think that it would help to have all this information just in the PR,
instead of navigating
between PR and Issue.
---------
Here is an example of a PR that was merged without an associated GitHub
Issue
https://github.com/twisted/twisted/pull/12095
Do you see any disadvantages of merging such a PR?
----------
What do you think?
Thanks for the feedback.
--
Adi Roiban
_______________________________________________
Twisted mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/twisted.python.org/
Message archived at
https://mail.python.org/archives/list/[email protected]/message/L6GEKQYSWUX4NBIHYEML3AKB2PXDD56N/
Code of Conduct: https://twisted.org/conduct
