Skip to content

Add CLAUDE.md guidance for Claude Code - #41

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

denis-yuen merged 1 commit into
mainfrom
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 build/codegen flow (Swagger Codegen + javax→jakarta replacer + flatten-plugin generated/ output), dependency conventions, and PR/JIRA conventions carried over from dockstore/dockstore where applicable, for future Claude Code sessions working in this repo.

Review Instructions
No code changes, just a new documentation file — a quick read-through is sufficient.

Issue
N/A

Security and Privacy

  • 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 build/codegen flow, dependency conventions, and PR/JIRA
conventions carried over from dockstore/dockstore where applicable.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@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:06
@denis-yuen
denis-yuen marked this pull request as ready for review September 18, 2026 15:06
@denis-yuen
denis-yuen merged commit e54e441 into main Sep 21, 2026
2 checks passed
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