Skip to content

Update backend development architecture docs#12175

Open
officialasishkumar wants to merge 1 commit into
cBioPortal:masterfrom
officialasishkumar:docs/backend-clean-architecture
Open

Update backend development architecture docs#12175
officialasishkumar wants to merge 1 commit into
cBioPortal:masterfrom
officialasishkumar:docs/backend-clean-architecture

Conversation

@officialasishkumar

@officialasishkumar officialasishkumar commented May 25, 2026

Copy link
Copy Markdown
Contributor

Fix #11403

Describe changes proposed in this pull request:

  • Update the backend code organization documentation for the current single-module Spring Boot backend.
  • Document the package-level application, domain, infrastructure, legacy, shared, resource, and test boundaries.
  • Refresh backend development guidance for the current master/v7 ClickHouse-only codebase.
  • Update the architecture overview language so it no longer describes the old multi-module/importer-oriented backend layout.

Checks

  • The commits in the pull request have descriptive commit messages, including a short title and a paragraph describing the change.
  • Documentation-only change validated with git diff --check.
  • No application logic based on clinical attributes is added.
  • Apply the relevant release-drafter label for this pull request: documentation.
  • Screenshots are not applicable for this documentation update.
  • Reviewers can be routed through the normal maintainer triage process.

Replace the outdated multi-module backend documentation with the current single-module Spring Boot package layout, including application, domain, infrastructure, legacy, resources, and test boundaries.
Copilot AI review requested due to automatic review settings May 25, 2026 01:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates backend developer documentation to reflect the v7 single-module Spring Boot architecture with clean-architecture package layout, replacing outdated multi-module Maven guidance.

Changes:

  • Rewrites Backend-Development-Guidelines.md with current architecture, REST, domain, data access, testing, and configuration guidance.
  • Rewrites Backend-Code-Organization.md to describe the application/domain/infrastructure/legacy package layout and ClickHouse-based runtime.
  • Updates Architecture-Overview.md to remove references to the old multi-module Maven structure.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/development/Backend-Development-Guidelines.md Replaces deprecated guidelines with v7-oriented guidance covering architecture, REST, domain, data access, legacy, tests, configuration, and code style.
docs/development/Backend-Code-Organization.md Replaces multi-module Maven description with a package-based clean architecture overview and feature-addition workflow.
docs/Architecture-Overview.md Updates backend description to reflect a single-module Spring Boot application.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sonarqubecloud

Copy link
Copy Markdown

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.

Update cbioportal backend developer docs to reflect latest clean arch change

2 participants