Add comprehensive code optimization guide

[awanawana]

This PR adds a comprehensive code optimization guide covering performance, quality, security, and best practices for the project.

---

Summary by CodeRabbit

• Documentation
  • Added a comprehensive code optimization guide offering structured guidance on performance optimization, code quality improvements, security best practices, and maintainability strategies. Includes concrete optimization suggestions, practical performance tips, security recommendations, optimization metrics, and implementation steps.

[vercel]

Someone is attempting to deploy a commit to the rohitg00's projects Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

📝 Walkthrough

Walkthrough

A new CODE_OPTIMIZATION_GUIDE.md documentation file is added containing structured guidance on performance optimization, code quality, security, maintainability, best practices, and concrete project-specific optimization recommendations. This is a documentation-only addition with no code changes.

Changes

Cohort / File(s)	Summary
Documentation CODE_OPTIMIZATION_GUIDE.md	New guide document providing structured optimization recommendations across performance, code quality, security, and maintainability with project-specific and general best practices.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐰 A guide for cleaner code has come,
With tips to make our systems hum,
Performance, security, and grace,
Best practices in every place! ✨

🚥 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 'Add comprehensive code optimization guide' directly and accurately summarizes the main change—adding a new documentation file with optimization guidance.
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
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

[coderabbitai]

🧹 Nitpick comments (3)

CODE_OPTIMIZATION_GUIDE.md (3)

38-48: Consider adding code examples for better clarity.

The recommendations are sound, but adding concrete Python code examples would make this guide significantly more actionable. For instance:

• Line 42: Show an example of structured logging implementation
• Line 48: Demonstrate functools.lru_cache usage
• Lines 44-46: Provide before/after examples of data structure optimization

Code examples would help developers understand not just what to optimize, but how to implement these improvements.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CODE_OPTIMIZATION_GUIDE.md` around lines 38 - 48, Add short, concrete Python
snippets to the "日志系统" and "性能优化技巧" sections to illustrate the advice: for
"日志系统" provide a brief example using Python's logging with structured JSON
output (showing logger setup and an example log call), for "性能优化技巧" include a
before/after of replacing a list scan with a set/dict for O(1) lookups and a
small demonstration of functools.lru_cache usage (decorator on a pure function)
to illustrate caching benefits; place each snippet inline under the relevant
bullets (e.g., under "日志系统", under the bullet mentioning functools.lru_cache,
and adjacent to the data-structure bullet) so readers can see concrete
implementation patterns that correspond to the recommendations.

---

1-71: Consider adding English translations or making this bilingual.

The entire guide is written in Chinese, which may limit accessibility for international contributors. For a project hosted on GitHub, consider either:

• Adding English translations alongside the Chinese content
• Creating a separate English version (e.g., CODE_OPTIMIZATION_GUIDE.en.md)
• Using a bilingual format with sections in both languages

This would make the valuable optimization guidance accessible to a broader audience.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CODE_OPTIMIZATION_GUIDE.md` around lines 1 - 71, The guide
(CODE_OPTIMIZATION_GUIDE.md) is entirely in Chinese; add an English version or
bilingual content to improve accessibility by either: 1) creating a parallel
English file (e.g., CODE_OPTIMIZATION_GUIDE.en.md) with full translations of
each section and headings (Performance, Code Quality, Security, Maintainability,
Best Practices, Specific Suggestions, Metrics, Implementation Steps), or 2)
converting the current file to a bilingual layout by appending English
translations under each Chinese heading/paragraph (e.g., "## 🎯 代码优化指南 / Code
Optimization Guide", translate each bullet and section), and ensure titles like
"性能优化", "代码质量", "安全性", "可维护性", and "最佳实践" have clear English equivalents for
contributors.

---

56-61: Provide context for optimization metrics.

The specific targets (20% execution time reduction, 15% memory reduction, 80%+ test coverage) would be more meaningful with:

• Current baseline measurements for the project
• Rationale for why these specific percentages are targeted
• Guidance on how to measure these metrics

Consider adding a section on how to establish baselines before optimization, or make these examples rather than fixed targets.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CODE_OPTIMIZATION_GUIDE.md` around lines 56 - 61, The "📈 优化指标" section
currently lists fixed targets without context; update that section (the "## 📈
优化指标" block) to include: 1) a short "Baseline" subsection describing how to
capture current metrics (e.g., collect median execution time, peak/resident
memory, current test coverage) and where to record them; 2) a brief "Rationale"
line for each target explaining why 20%/15%/80% were chosen (or mark them as
illustrative examples); and 3) a "Measurement" subsection that prescribes
tools/commands or metrics to use (e.g., profiling tool, memory profiler,
coverage tool) and how to compute percent change, or alternatively change the
three fixed numbers to labeled examples such as "example targets: ~20% time,
~15% memory, 80%+ coverage" so readers know they’re not mandatory.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CODE_OPTIMIZATION_GUIDE.md`:
- Around line 38-48: Add short, concrete Python snippets to the "日志系统" and
"性能优化技巧" sections to illustrate the advice: for "日志系统" provide a brief example
using Python's logging with structured JSON output (showing logger setup and an
example log call), for "性能优化技巧" include a before/after of replacing a list scan
with a set/dict for O(1) lookups and a small demonstration of
functools.lru_cache usage (decorator on a pure function) to illustrate caching
benefits; place each snippet inline under the relevant bullets (e.g., under
"日志系统", under the bullet mentioning functools.lru_cache, and adjacent to the
data-structure bullet) so readers can see concrete implementation patterns that
correspond to the recommendations.
- Around line 1-71: The guide (CODE_OPTIMIZATION_GUIDE.md) is entirely in
Chinese; add an English version or bilingual content to improve accessibility by
either: 1) creating a parallel English file (e.g.,
CODE_OPTIMIZATION_GUIDE.en.md) with full translations of each section and
headings (Performance, Code Quality, Security, Maintainability, Best Practices,
Specific Suggestions, Metrics, Implementation Steps), or 2) converting the
current file to a bilingual layout by appending English translations under each
Chinese heading/paragraph (e.g., "## 🎯 代码优化指南 / Code Optimization Guide",
translate each bullet and section), and ensure titles like "性能优化", "代码质量",
"安全性", "可维护性", and "最佳实践" have clear English equivalents for contributors.
- Around line 56-61: The "📈 优化指标" section currently lists fixed targets without
context; update that section (the "## 📈 优化指标" block) to include: 1) a short
"Baseline" subsection describing how to capture current metrics (e.g., collect
median execution time, peak/resident memory, current test coverage) and where to
record them; 2) a brief "Rationale" line for each target explaining why
20%/15%/80% were chosen (or mark them as illustrative examples); and 3) a
"Measurement" subsection that prescribes tools/commands or metrics to use (e.g.,
profiling tool, memory profiler, coverage tool) and how to compute percent
change, or alternatively change the three fixed numbers to labeled examples such
as "example targets: ~20% time, ~15% memory, 80%+ coverage" so readers know
they’re not mandatory.

---

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6c0905 and 077a1bd.

📒 Files selected for processing (1)

• CODE_OPTIMIZATION_GUIDE.md