leetcode/AGENTS.md

Repository Guidelines

Project Structure & Module Organization

<<<<<<< HEAD Daily challenge archives (23/04, 24, 25) mirror the YYYY/MM problem drops from LeetCode; each subdirectory holds the source for a single prompt. Topic-driven folders (dataStruct, dynamic planning, greed, else, key, we) group reusable headers (*.h), Go entry points, and the occasional Python prototype. Shared helpers such as tools/map.h plus scratch runners (main.c, main.go) live in the repo root. Reproducible experiments sit in test/, alongside small driver programs (test/test1.c, test/file.c) and fixture files (test/example.txt). Place new assets beside the closest-matching module and keep helper code centralized in tools/ so every language target can include it via #include "tools/map.h".

Build, Test, and Development Commands

• gcc main.c -I greed -I dataStruct -I tools -std=c17 -Wall -Wextra -O2 -o .build/main.exe: compile a local driver that stitches headers together; point the include path at whichever topic folder contains the solution under test.
• clang++ 25\\11\\solution.cpp -I tools -std=c++20 -Wall -Wextra -O2 -o .build/2511.exe && .\\.build\\2511.exe < test\\example.txt: run C++ implementations that live in the dated folders with sample input.
• go run main.go: execute Go stubs or quick playgrounds when validating algorithm ideas.

Coding Style & Naming Conventions

C/C++ code uses 4-space indents, brace-on-same-line, and camelCase for functions that mirror LeetCode signatures (largestNumber, maxProfit). Keep headers self-contained; include <stdlib.h>, <string.h>, etc. directly. Prefer descriptive file names that equal the problem id (greed/179.h, dataStruct/409.h). Python helpers should follow snake_case and stay under 80 columns to match the existing scripts (greed/11.py, lcs01.py).

Testing Guidelines

Driver files inside test/ document how to wire solutions into simple harnesses. When adding a solution, drop a focused test driver (e.g., test/179_largestNumber.c) and feed it sample cases through redirected stdin (.\\build\\179.exe < test\\example.txt). Keep assertions explicit so reviewers can trace failing inputs quickly.

Commit & Pull Request Guidelines

Recent commits use numeric messages (717, 251116) that track the corresponding LeetCode id or date. Continue that convention: <problem-id>[-optional-note] keeps history scannable. Pull requests should mention the problem link, describe the approach/complexity, list any new tests, and attach screenshots only when visual assets change. Reference related issues or discussions to make triage easy.

• Algorithms and data structures live under topic folders such as dataStruct/, dynamic planning/, greed/, else/, key/, and we/; each subfolder holds problem-specific source files.
• Shared helpers (e.g., custom containers) sit in tools/ and tools.h; include these with -Itools when compiling C/C++.
• Scratch outputs should go to build/; cmake-build-debug/ is IDE-generated and should stay untracked. Tests and small fixtures live in test/ (see test/example.txt).
• Paths with spaces (e.g., dynamic planning/) need quoting in shells: g++ -std=c++17 "dynamic planning/xxx.cpp".

Build, Test, and Development Commands

• C++17 compile (recommended by .clangd): g++ -std=c++17 -O2 -Itools <source>.cpp -o build/<name>; add -Wall -Wextra when iterating.
• C compile: gcc -O2 -Itools <source>.c -o build/<name>.
• Go quick run: go run main.go.
• Example test build & run: gcc -Itools test/test1.c -o build/test1 && ./build/test1.
• Keep binaries inside build/ and out of version control.

Coding Style & Naming Conventions

• Use 4-space indentation; prefer braces on new lines consistently across functions and control blocks.
• Favor snake_case for C helpers and CamelCase types for C++ classes/structs; keep filenames descriptive (heap_top_k.cpp, queue_with_two_stack.c).
• Rely on standard library containers/algorithms where possible; add brief comments only for non-obvious logic or tricky edge cases.
• Run code through clang-format (C/C++) if available; keep Go files formatted via gofmt.

Testing Guidelines

• Add minimal repros under test/ named after the problem (test_<id>.c) and keep fixtures small.
• When adding new logic, provide a tiny driver main or test function that exercises edge cases; show expected input/output in comments.
• Prefer deterministic tests; avoid reading/writing outside the repo except for build/.

Commit & Pull Request Guidelines

• Commit messages: short, imperative, and scoped (e.g., add heap merge helper, fix queue pop bug); avoid bundling unrelated fixes.
• Before opening a PR, summarize the problem solved, approach taken, and key follow-up items; paste the commands you ran (build/test) with outcomes.
• Do not commit generated binaries, IDE folders (cmake-build-debug/), or local artifacts.
• Link related issues or references when applicable; include screenshots only if the change affects observable output.*** >>>>>>> origin/main