CLAUDE.md
This commit is contained in:
45
CLAUDE.md
Normal file
45
CLAUDE.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Project Overview
|
||||
|
||||
pfs-tftp is a TFTP (Trivial File Transfer Protocol) implementation in Rust. The project is in early development.
|
||||
|
||||
## Build Commands
|
||||
|
||||
```bash
|
||||
# Build the project
|
||||
cargo build
|
||||
|
||||
# Build release version
|
||||
cargo build --release
|
||||
|
||||
# Run the application
|
||||
cargo run
|
||||
|
||||
# Run tests
|
||||
cargo test
|
||||
|
||||
# Run a single test
|
||||
cargo test test_name
|
||||
|
||||
# Check code without building
|
||||
cargo check
|
||||
|
||||
# Format code
|
||||
cargo +nightly fmt
|
||||
|
||||
# Run linter
|
||||
cargo clippy
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
This is a Rust binary crate using edition 2024. The main entry point is `src/main.rs`.
|
||||
|
||||
|
||||
## Commits
|
||||
- Commits should follow Conventional Commits specification.
|
||||
- Commits should be small and focused.
|
||||
- Commit messages should be clear and descriptive. They should explain the "what" and "why" of the change. Someone in 5 years should be able to comprehend the purpose of the commit. So make sure you add enough context.
|
||||
Reference in New Issue
Block a user