-
Notifications
You must be signed in to change notification settings - Fork 789
Add PR size guidelines to CONTRIBUTING.md #4888
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?
Conversation
|
Totally agree |
JWinermaSplunk
left a comment
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.
nitpick: I might change If you do this and want the community to understand how your small PR fits into the context of your larger change, to If you want the community to understand how your small PR fits into the context of your larger change, and remove the second incremental from Regardless, strive to provide clear, incremental value to the repository for every incremental change you make, but that is just personal preference. Otherwise, LGTM!
|
PR probably also does not need a CHANGELOG |
| If your work requires more extensive changes, consider a series of small PRs instead. If you want the community to | ||
| understand how your small PR fits into the context of your larger change, consider putting the large change | ||
| in your personal fork and providing a link to it in your PR description. Regardless, strive to provide clear, | ||
| incremental value to the repository for every change you make, such that the repository is always in a functional, | ||
| coherent state. | ||
|
|
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.
| If your work requires more extensive changes, consider a series of small PRs instead. If you want the community to | |
| understand how your small PR fits into the context of your larger change, consider putting the large change | |
| in your personal fork and providing a link to it in your PR description. Regardless, strive to provide clear, | |
| incremental value to the repository for every change you make, such that the repository is always in a functional, | |
| coherent state. | |
| - If your work requires more extensive changes, consider a series of small PRs instead. | |
| - If you want the community to | |
| understand how your small PR fits into the context of your larger change, consider putting the large change | |
| in your personal fork and providing a link to it in your PR description. | |
| - Regardless, strive to provide clear, | |
| incremental value to the repository for every change you make, such that the repository is always in a functional, | |
| coherent state. |
Maybe keep in bullets as well?
Description
This PR adds guidance on keeping pull requests small and focused to improve the review process.
Recommends 500 lines of additions or fewer, which comes from the Collector's CONTRIBUTING.md.
Fixes # (no issue)
Type of change
How Has This Been Tested?
N/A - Documentation-only change. Verified markdown renders correctly.
Does This PR Require a Contrib Repo Change?
Checklist: