Skip to content

CLAUDE.md

Latest commit

 

History

History
27 lines (21 loc) · 1.46 KB

CLAUDE.md

File metadata and controls

27 lines (21 loc) · 1.46 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

See CONTRIBUTING.md for build commands, testing, code style, and development workflow.

Workspace Structure

See README.md for the workspace layout and ARCH.md for some additional remark regarding important parts of LDK's architecture.

Development Rules

  • Always ensure tests pass before committing. To this end, you should run cargo +1.75.0 test for all affected crates and/or features. Upon completion of the full task you might prompt the user whether they want you to run the full CI tests via ./ci/ci-tests.sh. Note however that this script will run for a very long time, so please don't timeout when you do.
  • Run cargo +1.75.0 fmt --all before committing code changes. If rust 1.75.0 is not installed, skip this step.
  • Never add new dependencies unless explicitly requested
  • Please always disclose the use of any AI tools in commit messages and PR descriptions using a Co-Authored-By: line.
  • When adding new .rs files, please ensure to always add the licensing header as found, e.g., in lightning/src/lib.rs and other files.
  • When adding comments, do not refer to internal logic in other modules, instead make sure comments make sense in the context they're in without needing other context.
  • Try to keep code DRY - if new code you add is duplicate with other code, deduplicate it.