Skip to contentSkip to conversation

add hints to CLAUDE

RFC New Stephen Hemminger 1 participant 1 message Jul 8, 2025

lore
Share & tools
lore
#0 lore raw

RFC 1/1 add hints to CLAUDE

Soon users are going to want to use AI code generation like Claude with DPDK. There is a convention for giving hints to AI tool. Rough first draft

---
 CLAUDE.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 CLAUDE.md
CLAUDE.md new file +33 -0
new file mode 100644
index 0000000000..42dd2e2ade
@@ -0,0 +1,33 @@
+# Project: DPDK
+
+## Project Description
+DPDK is a set of libraries and drivers for fast packet processing.
+It supports many processor architectures and both Linux, FreeBSD and Windows.
+
+## Licensing
+Overall project use BSD-3-Clause license with some approved exceptions.
+
+## Build Commands
+This is a C library project that uses the meson build system:
+- Build: meson setup build && ninja -C build
+- Run tests: meson test -C build  --suite fast-tests
+
+## Code Conventions
+- license is per file via SPDX-License-Identifier
+- use Tabs for indentation
+- closing and opening braces on same line as the keyword
+- braces that are not necessary should be left out
+- avoid using camelCase and PascalCase
+
+
+## Project Structure
+- /lib/ - libraries
+- /license - reference copy of licenses
+- /drivers - device drivers
+- /examples - sample applications
+- /doc - documentation
+- /devtools - developer tools
+- /usertools - user tools
+- /kernel/
+  - /linux/uapi - exported kernel headers
+  - /freebsd - drivers for FreeBSD
Signature · 1 line
2.47.2