Skip to content

LCORE-607: Info about PR sizes in Contributing guide#1485

Merged
tisnik merged 1 commit intolightspeed-core:mainfrom
tisnik:lcore-607-info-about-pr-size-in-contributing-guide
Apr 12, 2026
Merged

LCORE-607: Info about PR sizes in Contributing guide#1485
tisnik merged 1 commit intolightspeed-core:mainfrom
tisnik:lcore-607-info-about-pr-size-in-contributing-guide

Conversation

@tisnik
Copy link
Copy Markdown
Contributor

@tisnik tisnik commented Apr 12, 2026

Description

LCORE-607: Info about PR sizes in Contributing guide

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

  • Assisted-by: N/A
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue #LCORE-607

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with a new pull request size section, including recommended scope targets (~200 lines), file count limits, and guidance for keeping pull requests focused on single features or bug fixes. Also covers splitting larger changes across multiple PRs and writing detailed commit messages.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 79d050c6-2ada-4cb3-8506-2c322557455f

📥 Commits

Reviewing files that changed from the base of the PR and between 07ca1b1 and a3a5d1e.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
  • GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
  • GitHub Check: build-pr
  • GitHub Check: Pylinter
  • GitHub Check: integration_tests (3.13)
  • GitHub Check: E2E: server mode / ci
  • GitHub Check: E2E: library mode / ci
  • GitHub Check: E2E Tests for Lightspeed Evaluation job
  • GitHub Check: unit_tests (3.13)
  • GitHub Check: unit_tests (3.12)
🔇 Additional comments (2)
CONTRIBUTING.md (2)

11-11: LGTM! TOC entry is properly formatted.

The table of contents entry is correctly formatted and logically placed between PR description guidance and the Definition of Done.


107-148: Excellent documentation addition!

This section provides comprehensive, actionable guidance on PR sizing that will help maintain code review quality and velocity. The content is well-structured and covers multiple important dimensions:

  • Clear numeric targets backed by research
  • Practical strategies for handling larger changes
  • Focus on reviewer experience and code quality
  • Concrete advice for splitting and sequencing work
  • Emphasis on atomic, self-contained changes

The writing is clear, professional, and consistent with the rest of the contributing guide.


Walkthrough

Added a "Pull request size" section to CONTRIBUTING.md with prescriptive guidance on PR scope, including size targets (~200 lines, under 500 generally), file count limits, focus requirements, and instructions for splitting larger work into multiple PRs with detailed commit messages.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Added new "Pull request size" section to table of contents and included detailed guidance on PR sizing targets, file modification limits, and best practices for maintaining focused, self-contained pull requests.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: adding information about PR sizes to the Contributing guide, which matches the pull request's objective and the documentation additions in CONTRIBUTING.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@tisnik tisnik merged commit d10381a into lightspeed-core:main Apr 12, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant