Add AGENTS.md and CLAUDE.md with project rules for AI coding agents#7902
Merged
sfc-gh-truwase merged 1 commit intodeepspeedai:masterfrom Mar 13, 2026
Merged
Add AGENTS.md and CLAUDE.md with project rules for AI coding agents#7902sfc-gh-truwase merged 1 commit intodeepspeedai:masterfrom
sfc-gh-truwase merged 1 commit intodeepspeedai:masterfrom
Conversation
8bcb6a5 to
e069937
Compare
Signed-off-by: Ma, Guokai <guokai.ma@gmail.com>
Collaborator
|
@delock thanks for the PR. The files seem to be duplicated content. Is this unavoidable? |
sfc-gh-truwase
approved these changes
Mar 13, 2026
Collaborator
Author
Hi @sfc-gh-truwase, Claude Code and OpenCode use different name for the file. OpenCode suggest duplicate the file and rely on agents to maintain consistency. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add AGENTS.md and CLAUDE.md to provide project-specific rules for AI coding agents (OpenCode, Claude Code, etc.) working on the
DeepSpeed codebase.
Motivation
AI coding agents are increasingly used for development tasks. Without project-specific instructions, they often produce PRs that violate DeepSpeed conventions — missing DCO sign-off, using import torch.distributed, making cosmetic formatting changes, or generating code that doesn't match the surrounding style. This file encodes those rules so agents follow them automatically.
What's included
Two identical files are provided (
AGENTS.mdfor OpenCode,CLAUDE.mdfor Claude Code) with a comment reminding contributors to keep them in sync.