Skip to content

[Task] Document the split-client migration and contribution workflow #6373

Description

@Aias00

Description

Background

Community contributors need a clear guide for contributing to the split Java client repository and for making coordinated changes across the main ShenYu repo and shenyu-client-java.

Tasks

  • Explain why the Java client is split from the main repo.
  • Explain the different JDK policies for client repo and main repo.
  • Explain how to build and test shenyu-client-java.
  • Explain how to run JDK 8/17/21/23/25 verification.
  • Explain how to test local client artifacts with main repo admin/bootstrap.
  • Explain when a change requires PRs in both repositories.
  • Add a PR checklist for client repo changes.
  • Add a PR checklist for main repo changes that affect client compatibility.

Expected Output

Contributor-facing documentation.

Acceptance Criteria

  • A new contributor can understand where to make client-related changes.
  • The documentation includes local verification commands.
  • The documentation explains cross-repo compatibility expectations.

Task List

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions