-
-
Notifications
You must be signed in to change notification settings - Fork 851
bpo-38101: Update devguide triaging keywords #570
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
bpo-38101: Update devguide triaging keywords #570
Conversation
@taleinat I wasn't sure how to find a reviewer for this/the reviewer in the issue from Sept. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @idomic, thanks for the PR!
It needs a bit more work but definitely in the right direction.
triaging.rst
Outdated
@@ -375,6 +375,13 @@ Various informational flags about the issue. Multiple values are possible. | |||
| easy | Fixing the issue should not take longer than a day for | | |||
| | someone new to contributing to Python to solve. | | |||
+---------------+------------------------------------------------------------+ | |||
| easy (C) | Fixing the issue should not take longer than a day for | | |||
| | someone new contributing to Python, focused on C/C++. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We just use C, so the mention of C++ here is out of place.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
triaging.rst
Outdated
+---------------+------------------------------------------------------------+ | ||
| security_issue| The issue would fit as, or is related as a security issue. | | ||
+---------------+------------------------------------------------------------+ | ||
| PEP 3121 | The issue fit as, or is related to the PEP 3123 module | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PEP number here is off, it should be 3121. Also, a few words about the subject of the PEP, and a link to it, would be very helpful.
I have made the requested changes; please review again |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, almost there! One more comment.
triaging.rst
Outdated
| PEP 3121 | The issue fit as, or is related to the PEP 3121 module | | ||
| | Which is the Extension Module Initialization and | | ||
| | Finalization, For More information: | | ||
| | https://www.python.org/dev/peps/pep-3121/ | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The wording and capitalization here are a bit clumsy. My suggestion:
"The issue is related to `PEP 3121`_: Extension Module Initialization and Finalization."
(The above assumes adding the link for PEP 3121 below it.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have made the requested changes; please review again
I have made the requested changes; please review again |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good @idomic, I've just a couple more small comments.
triaging.rst
Outdated
| easy (C) | Fixing the issue should not take longer than a day for | | ||
| | someone new contributing to Python, focused on C. | | ||
+---------------+------------------------------------------------------------+ | ||
| security_issue| The issue would fit as, or is related as a security issue. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| security_issue| The issue would fit as, or is related as a security issue. | | |
| security_issue| This is a security issue or is related to one. | |
triaging.rst
Outdated
| | someone new contributing to Python, focused on C. | | ||
+---------------+------------------------------------------------------------+ | ||
| security_issue| The issue would fit as, or is related as a security issue. | | ||
| | The main difference from "security" is that this is a | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"security" is out of context here, so maybe write something "The main difference from the "secutiry" issue type is..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added both changes, I think also since there is no security keyword in the bug tracker, the main difference is that is a definite problem right? While the security type above it is more for reporting a possible issue.
I have made the requested changes; please review again |
@taleinat I think the link to pep 3121 is failing the CI, any way to override it? |
@idomic, the CI is failing correctly! The build fails because you haven't defined where the "PEP 3121" link should point to. It needs to be like this: This is a paragraph that contains `a link`_.
.. _a link: https://domain.invalid/ For more info, check out similar links in this (or other ReST) documents, or the ReST Primer. |
Ok, after lots of commits (sorry haha), that's ready CI is passing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks for taking this up and following through, @idomic! |
Added 3 new keywords: pep 3121, security_issue, easy (C)