Skip to content

AGENTS.md

Latest commit

 

History

History
49 lines (32 loc) · 3.5 KB

AGENTS.md

File metadata and controls

49 lines (32 loc) · 3.5 KB

Repository Guidelines

Project Structure & Module Organization

This repository stores LeetCode solutions, local runners, and code-generation tooling across languages. Problem folders live under problems/problems_<id>/ and usually contain problem.md, problem_zh.md, solution.*, Solution.*, solution.md, and testcase files. Shared helpers are in python/, golang/, typescript/, cpp/, and rust/; algorithm notes are in algorithm_templates/; metadata is in data/; automated tests are in tests/. Multithreading problems use multi_threading/<id>/.

Build, Test, and Development Commands

  • make verify: run stable local checks across Python codegen/unit tests, TypeScript smoke tests, and Go helper packages.
  • make health: scan generated problem folders for missing docs, testcases, links, solutions, and Rust workspace drift.
  • make test: run the full Python pytest suite with PYTHONPATH=..
  • make test-unit: run fast unit tests marked unit.
  • make test-integration: run integration tests that may require language runtimes.
  • make test-codegen: validate code generation behavior.
  • make test-coverage: run pytest with terminal and HTML coverage reports.
  • npm test: run the full TypeScript/Jest suite through ts-jest.
  • make test-go-libs: run stable Go helper package tests.
  • python python/scripts/leetcode.py: launch the interactive LeetCode helper for fetching/submitting problems.

Use make help for the maintained command list.

Coding Style & Naming Conventions

Follow the target language style and existing generated files. Python uses pytest-compatible modules and 4-space indentation. Go code should be gofmt formatted. TypeScript uses lowercase filenames in typescript/ and Jest tests such as debug.test.ts. Problem directories use problems_<id>, with solution names like solution.py, solution.go, solution.ts, solution.rs, Solution.cpp, and Solution.java.

Testing Guidelines

Pytest discovers test_*.py and *_test.py under tests/; test classes start with Test, and test functions start with test_. Use markers from pytest.ini: unit, integration, codegen, and slow. For problem-level validation, run make test-daily, make test-problems, or the relevant language command. Add focused tests when changing code generation, language writers, shared models, or testcase parsing.

Commit & Pull Request Guidelines

Recent commits use short prefixes such as test: and fix:; examples include test: 3742 solution, test: [20260430] Add (3742), and fix: 题解链接bug. Keep messages scoped to one change. Pull requests should summarize changed problems or tooling, list test commands run, mention required environment variables, and link related issues when applicable.

Solution Style Preferences

  • Python solutions favor concise, trick-oriented approaches — avoid boilerplate.
  • Prefer math/insight over brute force when possible.
  • Keep solution files focused: one clean approach, not multiple explorations.

Done Means

  • Solution passes the problem's test cases (local runner or LeetCode submit).
  • No leftover debug prints or commented-out code in the solution file.
  • If adding tooling: make verify passes, relevant make test-* target passes.
  • Changed files are summarized.

Security & Configuration Tips

Do not commit .env, LeetCode cookies, PushDeer keys, or other secrets. Required local values include COOKIE, PROBLEM_FOLDER, LANGUAGES, LEETCODE_USER, and PYTHONPATH=.; see README.md for an example configuration.