Skip to content

[SPARK-57147] Add AGENTS.md and symlink CLAUDE.md to it - #696

Closed
dongjoon-hyun wants to merge 2 commits into
apache:mainfrom
dongjoon-hyun:SPARK-57147
Closed

dongjoon-hyun wants to merge 2 commits into
apache:mainfrom
dongjoon-hyun:SPARK-57147

Conversation

@dongjoon-hyun

Copy link
Copy Markdown
Member

What changes were proposed in this pull request?

This PR adds AGENTS.md, a contributor/agent guide for the repository, and CLAUDE.md as a
symlink to it.

Why are the changes needed?

To give contributors and AI agents one accurate reference for the build, test, style, and
contribution conventions. The symlink keeps CLAUDE.md and AGENTS.md in sync without duplication.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Documentation-only change. Verified that CLAUDE.md resolves to AGENTS.md.

Was this patch authored or co-authored using generative AI tooling?

Yes. Generated-by: Claude Code (Claude Opus 4.8)

Comment thread AGENTS.md Outdated
# Agent Guide — Apache Spark K8s Operator

Guidance for AI agents and contributors working in this repository
(Apache Spark™ Kubernetes Operator).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need Spark™ in Spark project or simply Spark?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, do you want me to remove the trademark?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, I remember we don't use trademark in our documents. If I'm wrong, feel free to add it.

@dongjoon-hyun

Copy link
Copy Markdown
Member Author

Thank you, @viirya and @peter-toth .

I removed the trademark to address the review comment.

@dongjoon-hyun dongjoon-hyun added this to the 1.0.0 milestone May 29, 2026
@dongjoon-hyun

Copy link
Copy Markdown
Member Author

Merged to main

@dongjoon-hyun
dongjoon-hyun deleted the SPARK-57147 branch May 29, 2026 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants