AgentSkillsCN

debugging

针对pikru的调试规范。在添加调试日志或排查问题时使用。重要规则:务必保留调试日志。

SKILL.md
--- frontmatter
name: debugging
description: Debugging conventions for pikru. Use when adding debug traces or investigating issues. Important rule - leave debug traces in place.

Debugging

When in doubt, add tracing:

  • C code: DBG() macro
  • Rust code: tracing::debug!() (not eprintln!)

IMPORTANT: Leave debug traces in place!

  • DO NOT remove DBG() calls from C code after debugging
  • DO NOT remove tracing::debug!() calls from Rust code after debugging
  • DO NOT run make clean in vendor/pikchr-c (it's disabled anyway)

Rationale

  • The C implementation is not used in production - debug traces are helpful for future investigations
  • Rust tracing can be turned on/off at compile time via RUST_LOG environment variable
  • Having traces in place makes future debugging much faster