Skip to content

Commit 6416154

Browse files
authored
Adds project rules and steering for Claude Code and Kiro. (#6907)
We already have some developer documentation that is relevant for AI tools as well as people. This adds instructions for Claude and Kiro to use them. For Claude Code it uses includes and for Kiro it is a symlink in the steering directory. Signed-off-by: David Venable <dlv@amazon.com>
1 parent 287321c commit 6416154

5 files changed

Lines changed: 20 additions & 2 deletions

File tree

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ data-prepper-main/src/test/resources/logstash-conf/logstash-filter.yaml
2525
.DS_Store
2626
.idea
2727
*.iml
28-
.kiro
28+
.kiro/*
29+
!.kiro/steering/
2930
.vscode
3031
.project
3132
.classpath
@@ -40,4 +41,3 @@ trace-tester.py
4041

4142
# Claude Code
4243
.claude/settings.local.json
43-
CLAUDE.md

.kiro/steering/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../CONTRIBUTING.md

.kiro/steering/developer_guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../docs/developer_guide.md

CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CLAUDE.md
2+
3+
OpenSearch Data Prepper welcomes AI-assisted development and does not require
4+
any particular AI tool. Guidance for contributors — human or AI — lives in the
5+
existing developer and contributing docs. This file imports those so Claude
6+
Code picks them up automatically; other AI tools should be pointed at the same
7+
files.
8+
9+
@docs/developer_guide.md
10+
@CONTRIBUTING.md

docs/developer_guide.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,12 @@ fails, please check the *Summary* section of that Action. There may be artifacts
251251
can download these and view the result information. Additionally, many builds have *Unit Test Results* job
252252
which includes a summary of the results.
253253

254+
## AI and agentic development
255+
256+
We welcome and encourage the use of AI tools and agentic development.
257+
This project does not enforce or require any particular AI tool and the tool choice is similar to choosing an IDE.
258+
If you want to add AI tooling to the project, please commit it in such a way that it can be used by other AI tools.
259+
254260
## More Information
255261

256262
We have the following pages for specific development guidance on the topics:

0 commit comments

Comments
 (0)