Augmenting `contributing.md` by KuntaiDu · Pull Request #2654 · LMCache/LMCache

KuntaiDu · 2026-02-28T00:19:40Z

What this PR does / why we need it:

This PR augments the rules for contributing.md.

Special notes for your reviewers:

If applicable:

this PR contains user facing changes - docs added
this PR contains unit tests

gemini-code-assist · 2026-02-28T00:19:55Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request aims to improve the developer experience by providing detailed contribution guidelines and enhancing the robustness of error reporting within the application's multiprocessing components. The updated documentation will help new and existing contributors adhere to project standards, while the logging improvements will make it easier to diagnose and resolve issues by capturing more comprehensive error information.

Highlights

Enhanced Contributing Guidelines: The CONTRIBUTING.md file has been significantly expanded to include comprehensive guidelines for setting up the Python environment, running tests, linting, code quality checks, import ordering, and general coding conventions such as type hints, docstrings, encapsulation, and code organization.
Improved Error Logging: Error handling in several multiprocessing-related files (blend_server.py, mq.py, server.py) has been updated to use logger.exception instead of logger.error or logger.warning. This change ensures that full stack traces are automatically logged when exceptions occur, greatly aiding in debugging and troubleshooting.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

CONTRIBUTING.md
- Added a new section 'Basics of LMCache dev' detailing the default branch for development.
- Introduced a 'Python Environment' section with instructions for uv to manage virtual environments and dependencies.
- Included a 'Testing' section with commands for running tests, test dependencies, and best practices for writing tests.
- Added a 'Linting & Code Quality' section with commands for pre-commit, ruff, isort, mypy, and codespell, along with notes on C++/CUDA/Rust formatting and SPDX license headers.
- Detailed 'Import Ordering' conventions with a clear example.
- Explained 'SLF (Private Member Access)' rules and their project-wide enforcement.
- Provided a 'Coding Conventions' section covering type hints, docstrings, encapsulation, and code organization.
lmcache/v1/multiprocess/blend_server.py
- Updated exception logging in _retrieve_one_paragraph to use logger.exception for better stack trace capture.
lmcache/v1/multiprocess/mq.py
- Modified exception logging in _notify_response to use logger.exception.
- Changed exception logging in _main_loop to use logger.exception for request handling errors.
lmcache/v1/multiprocess/server.py
- Replaced logger.warning with logger.exception in the _retrieve_loop exception handler.

Activity

The pull request was created by KuntaiDu.
The pull request description indicates that it augments the rules for contributing.md.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

sammshen

LGTM!

gemini-code-assist

Code Review

This pull request significantly augments the CONTRIBUTING.md file with detailed guidelines for development, testing, and coding conventions, which will be very helpful for new contributors. It also improves error logging across several modules by replacing logger.error and logger.warning with logger.exception in except blocks, which will provide more context (including stack traces) when errors occur. My feedback includes a suggestion to clarify an installation instruction in the updated CONTRIBUTING.md to avoid confusion for new contributors.

ApostaC

LGTM!

sammshen

LGTM!

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>

* use logger.exception instead of logger.error to log stack trace Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * remove exception from logger.exception Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * augment contributing.md Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * revert non-CONTRIBUTING.md changes Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * make dco happy Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * trigger CI again --- git is failing Signed-off-by: KuntaiDu <kuntai@uchicago.edu> --------- Signed-off-by: KuntaiDu <kuntai@uchicago.edu> Co-authored-by: Samuel Shen <slshen@tensormesh.ai>

* use logger.exception instead of logger.error to log stack trace Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * remove exception from logger.exception Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * augment contributing.md Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * revert non-CONTRIBUTING.md changes Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * make dco happy Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * trigger CI again --- git is failing Signed-off-by: KuntaiDu <kuntai@uchicago.edu> --------- Signed-off-by: KuntaiDu <kuntai@uchicago.edu> Co-authored-by: Samuel Shen <slshen@tensormesh.ai> Signed-off-by: shaoxiawjc <wjc2800@163.com>

* use logger.exception instead of logger.error to log stack trace Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * remove exception from logger.exception Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * augment contributing.md Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * revert non-CONTRIBUTING.md changes Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * make dco happy Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * trigger CI again --- git is failing Signed-off-by: KuntaiDu <kuntai@uchicago.edu> --------- Signed-off-by: KuntaiDu <kuntai@uchicago.edu> Co-authored-by: Samuel Shen <slshen@tensormesh.ai> Signed-off-by: Aaron Wu <aaron.wu@dell.com>

* use logger.exception instead of logger.error to log stack trace Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * remove exception from logger.exception Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * augment contributing.md Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * revert non-CONTRIBUTING.md changes Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * make dco happy Signed-off-by: KuntaiDu <kuntai@uchicago.edu> * trigger CI again --- git is failing Signed-off-by: KuntaiDu <kuntai@uchicago.edu> --------- Signed-off-by: KuntaiDu <kuntai@uchicago.edu> Co-authored-by: Samuel Shen <slshen@tensormesh.ai>

sammshen approved these changes Feb 28, 2026

View reviewed changes

gemini-code-assist Bot reviewed Feb 28, 2026

View reviewed changes

Comment thread CONTRIBUTING.md

YaoJiayi approved these changes Mar 3, 2026

View reviewed changes

ApostaC approved these changes Mar 3, 2026

View reviewed changes

sammshen approved these changes Mar 3, 2026

View reviewed changes

KuntaiDu and others added 7 commits March 3, 2026 18:53

use logger.exception instead of logger.error to log stack trace

c018458

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>

remove exception from logger.exception

89c965a

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>

augment contributing.md

ae8209d

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>

revert non-CONTRIBUTING.md changes

d0c2328

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>

make dco happy

cf77580

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>

trigger CI again --- git is failing

edef6e7

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>

Merge branch 'dev' into kuntai-edit-agent

2f39e47

KuntaiDu enabled auto-merge (squash) March 5, 2026 00:48

github-actions Bot added the full Run comprehensive tests on this PR label Mar 5, 2026

KuntaiDu merged commit 79edf9e into LMCache:dev Mar 5, 2026
21 checks passed

KuntaiDu deleted the kuntai-edit-agent branch March 5, 2026 02:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Augmenting `contributing.md`#2654

Augmenting `contributing.md`#2654
KuntaiDu merged 7 commits intoLMCache:devfrom
KuntaiDu:kuntai-edit-agent

KuntaiDu commented Feb 28, 2026

Uh oh!

gemini-code-assist Bot commented Feb 28, 2026

Uh oh!

sammshen left a comment

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

ApostaC left a comment

Uh oh!

sammshen left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

KuntaiDu commented Feb 28, 2026

Uh oh!

gemini-code-assist Bot commented Feb 28, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

sammshen left a comment

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

ApostaC left a comment

Choose a reason for hiding this comment

Uh oh!

sammshen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants