Skip to content

Conversation

@pmcollins
Copy link
Member

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

N/A - Documentation-only change. Verified markdown renders correctly.

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR: (to be created after this PR is merged)
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated (this PR IS a documentation update)

@pmcollins pmcollins requested a review from a team as a code owner January 29, 2026 20:38
@shuwpan
Copy link

shuwpan commented Jan 29, 2026

Totally agree

Copy link

@JWinermaSplunk JWinermaSplunk left a 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!

@JWinermaSplunk
Copy link

PR probably also does not need a CHANGELOG

@pmcollins pmcollins added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 29, 2026
Comment on lines +181 to +186
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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants