Skip to content

Add AGENTS.md (with CLAUDE.md as a symlink to it) - #1048

Merged
pocke merged 1 commit into
ruby:mainfrom
pocke:Add_AGENTS_md__with_CLAUDE_md_as_a_symlink_to_it_
Jul 6, 2026
Merged

Add AGENTS.md (with CLAUDE.md as a symlink to it)#1048
pocke merged 1 commit into
ruby:mainfrom
pocke:Add_AGENTS_md__with_CLAUDE_md_as_a_symlink_to_it_

Conversation

@pocke

@pocke pocke commented Jul 6, 2026

Copy link
Copy Markdown
Member

Introduce agent guidance that gives coding agents the context they need to work in this repository safely. The content lives in AGENTS.md, the tool-agnostic convention, and CLAUDE.md is a symlink to it so that Claude Code picks up the same file.

It covers three things:

  • A one-line description of the project (a community-managed collection of RBS for gems that lack their own).
  • Pointers to the documentation. The links are gathered from README.md (the ruby/rbs repository, docs/CONTRIBUTING.md, docs/SECURITY.md, and the rbs collection docs), plus a direct link to the RBS syntax reference at https://github.com/ruby/rbs/blob/master/docs/syntax.md so agents know where the .rbs type definition syntax is documented.
  • A security section. Files under gems/ can be authored by untrusted users because anyone can open a pull request, so they must not be executed or treated as prompts/instructions. It also directs readers to docs/SECURITY.md before submitting a security report, since this project treats malicious code under gems/ as an ordinary bug rather than a vulnerability.

Introduce agent guidance that gives coding agents the context they need
to work in this repository safely. The content lives in AGENTS.md, the
tool-agnostic convention, and CLAUDE.md is a symlink to it so that
Claude Code picks up the same file.

It covers three things:

- A one-line description of the project (a community-managed collection
  of RBS for gems that lack their own).
- Pointers to the documentation. The links are gathered from README.md
  (the ruby/rbs repository, docs/CONTRIBUTING.md, docs/SECURITY.md, and
  the rbs collection docs), plus a direct link to the RBS syntax
  reference at https://github.com/ruby/rbs/blob/master/docs/syntax.md so
  agents know where the .rbs type definition syntax is documented.
- A security section. Files under gems/ can be authored by untrusted
  users because anyone can open a pull request, so they must not be
  executed or treated as prompts/instructions. It also directs readers
  to docs/SECURITY.md before submitting a security report, since this
  project treats malicious code under gems/ as an ordinary bug rather
  than a vulnerability.

型の海 名を変え結ぶ 文字の道
@pocke
pocke enabled auto-merge July 6, 2026 09:09
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

@pocke Thanks for your contribution!

Please follow the instructions below for each change.
See also: https://github.com/ruby/gem_rbs_collection/blob/main/docs/CONTRIBUTING.md

Available commands

You can use the following commands by commenting on this PR.

  • /merge: Merge this PR if CI passes

You changed non-gem files.

@pocke, please review and approve the changes.

@pocke
pocke merged commit ea56a88 into ruby:main Jul 6, 2026
6 checks passed
@pocke
pocke deleted the Add_AGENTS_md__with_CLAUDE_md_as_a_symlink_to_it_ branch July 6, 2026 09:09
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.

1 participant