Skip to content

Add CLAUDE.md guidance for this repository - #11

Merged
denis-yuen merged 1 commit into
mainfrom
docs/add-claude-md
Sep 21, 2026
Merged

denis-yuen merged 1 commit into
mainfrom
docs/add-claude-md

Conversation

@denis-yuen

@denis-yuen denis-yuen commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

Description
Adds a CLAUDE.md documenting the OpenAPI codegen build pipeline (swagger-codegen → jakarta replacer → generated source roots) and generated package layout, plus generic PR/branching/dependency conventions adapted from dockstore/dockstore's CLAUDE.md.

Review Instructions
Docs-only change; no code or build behavior affected. ./mvnw clean install passes.

Issue
N/A

Security and Privacy

No security or privacy implications; this only adds a documentation file.

Please make sure that you've checked the following before submitting your pull request. Thanks!

  • Check that you pass the basic style checks and unit tests by running mvn clean install
  • Ensure that the PR targets the correct branch. Check the milestone or fix version of the ticket.
  • Follow the existing JPA patterns for queries, using named parameters, to avoid SQL injection
  • If you are changing dependencies, check the Snyk status check or the dashboard to ensure you are not introducing new high/critical vulnerabilities
  • Assume that inputs to the API can be malicious, and sanitize and/or check for Denial of Service type values, e.g., massive sizes
  • Do not serve user-uploaded binary images through the Dockstore API
  • Ensure that endpoints that only allow privileged access enforce that with the @RolesAllowed annotation
  • Do not create cookies, although this may change in the future
  • If this PR is for a user-facing feature, create and link a documentation ticket for this feature (usually in the same milestone as the linked issue). Style points if you create a documentation PR directly and link that instead.

🤖 Generated with Claude Code

Documents the OpenAPI codegen build pipeline and generated package
layout, and adopts the generic PR/branching/dependency conventions
from dockstore/dockstore's CLAUDE.md (adjusted for this repo's actual
main-only branching model).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@denis-yuen
denis-yuen marked this pull request as ready for review September 18, 2026 15:17
@denis-yuen denis-yuen self-assigned this Sep 18, 2026
@denis-yuen
denis-yuen requested review from a team and svonworl and removed request for a team September 18, 2026 15:18
@denis-yuen
denis-yuen merged commit c7ce12c into main Sep 21, 2026
1 check passed
@denis-yuen
denis-yuen deleted the docs/add-claude-md branch September 21, 2026 17:25
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.

2 participants