-
-
Notifications
You must be signed in to change notification settings - Fork 986
Mention typo fixes and large PRs #1782
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
base: main
Are you sure you want to change the base?
Changes from all commits
db9404f
eeef778
09c68d2
3f2b045
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -238,6 +238,11 @@ should do to help ensure that your pull request is accepted. | |||||||||||||||||||||||||||||||||||||
| changes, because there might be interferences unknown to you between your | ||||||||||||||||||||||||||||||||||||||
| changes and some other part of the interpreter. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| #. **Keep your pull request focused and small.** A pull request should address | ||||||||||||||||||||||||||||||||||||||
| one issue or add one feature. Combining multiple unrelated changes makes a | ||||||||||||||||||||||||||||||||||||||
| pull request harder to review and increases the number of people notified | ||||||||||||||||||||||||||||||||||||||
| unnecessarily. When in doubt, split into separate pull requests. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| #. Proper :ref:`documentation <documenting>` additions/changes should be included. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
@@ -260,6 +265,26 @@ See also `python/cpython#126133 | |||||||||||||||||||||||||||||||||||||
| <https://github.com/python/cpython/issues/126133#issuecomment-2460824052>`__. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| .. _typo-fixes: | ||||||||||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you mean to reference the section somewhere? |
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Typo fixes | ||||||||||||||||||||||||||||||||||||||
| ========== | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Fixing typos and grammatical errors in documentation is a welcome | ||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||
| contribution that does not require a linked issue. The most appropriate | ||||||||||||||||||||||||||||||||||||||
| places for such fixes are: | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| * The ``Doc/`` directory (end-user documentation) | ||||||||||||||||||||||||||||||||||||||
| * Internal documentation, such as files in ``Misc/`` | ||||||||||||||||||||||||||||||||||||||
| * News entries under ``Misc/NEWS.d/`` | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| Keep typo-fix PRs **small and focused**, ideally limited to one file or a | ||||||||||||||||||||||||||||||||||||||
| small set of closely related files. Large PRs that touch many unrelated files | ||||||||||||||||||||||||||||||||||||||
| notify a large number of reviewers unnecessarily and are harder to review. | ||||||||||||||||||||||||||||||||||||||
| Large typo-fix PRs, or PRs touching directories outside those listed above, | ||||||||||||||||||||||||||||||||||||||
| may be closed with a reference to this section. | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+275
to
+285
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IMO we can also include
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was on the fence about InternalDocs. No objection about keeping it in. |
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| .. _patchcheck: | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ``patchcheck`` | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
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.