Skip to content

Update microsphere-spring-cloud and add GitHub prompt templates - #26

Merged
mercyblitz merged 7 commits into
microsphere-projects:release-1.xfrom
mercyblitz:dev-1.x
May 27, 2026
Merged

Update microsphere-spring-cloud and add GitHub prompt templates#26
mercyblitz merged 7 commits into
microsphere-projects:release-1.xfrom
mercyblitz:dev-1.x

Conversation

@mercyblitz

Copy link
Copy Markdown
Contributor

This pull request introduces several improvements to project documentation and developer onboarding, along with a minor version bump for the Microsphere Spring Cloud dependency. The main changes are the addition of comprehensive GitHub Copilot instructions, prompt templates for various developer tasks, and updates to the Maven parent versions to ensure compatibility with the latest Microsphere Spring Cloud release.

Documentation and Developer Experience Enhancements:

  • Added a detailed .github/copilot-instructions.md file that explains build/test commands, high-level architecture, key conventions, and testing practices for the project.
  • Introduced prompt templates in .github/prompts/ for:
    • Creating comprehensive README.md files (create-readme.prompt.md)
    • Generating OpenAPI 3.0 specs from code (document-api.prompt.md)
    • Explaining code in a beginner-friendly way (explain-code.prompt.md)
    • Generating focused unit tests for selected functions (generate-unit-tests.prompt.md)
    • Providing phased onboarding plans for new team members (onboarding-plan.prompt.md)
    • Performing comprehensive code reviews with actionable feedback (review-code.prompt.md)

Dependency Version Updates:

  • Updated the microsphere-spring-cloud.version property in microsphere-gateway-parent/pom.xml from 0.1.12 to 0.1.13 to use the latest BOM.
  • Updated the parent POM version in the root pom.xml from 0.1.12 to 0.1.13 for consistency and compatibility.

github-actions Bot and others added 5 commits May 21, 2026 13:30
Update project to use microsphere-spring-cloud version 0.1.13: incremented <microsphere-spring-cloud.version> in microsphere-gateway-parent/pom.xml and updated the parent version in the root pom.xml to 0.1.13 to align modules with the new release.
Add six new prompt templates under .github/prompts to standardize agent guidance for common developer workflows: create-readme, document-api (OpenAPI 3.0 generation), explain-code, generate-unit-tests, onboarding-plan, and review-code. Each prompt contains role, task, guidelines, and input placeholders to help automate documentation, testing, code review, and onboarding tasks.
Replace interactive input placeholders in .github/prompts/explain-code.prompt.md with fixed defaults: set 'Code to explain' to 'Each Java file' and 'Target audience' to 'beginners, intermediate developers, seansoned developers'. This simplifies the prompt by removing the ${input:...} variables. Note: the audience list includes a likely misspelling ('seansoned').
Add .github/copilot-instructions.md containing contributor and Copilot guidance: build/test commands, high-level project architecture, runtime module responsibilities, web-endpoint routing behavior, and key conventions (custom we:// scheme, per-route exclusions, feature flags). Intended to help contributors and automated tooling understand build steps, auto-configuration registration, and testing conventions.
@codecov

codecov Bot commented May 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Restructure and modernize README content: tidy up badges (update Codecov branch), rewrite the project overview, and add a "Why It's Useful" section. Replace the old modules table with a clearer module list (add Server MVC module), add prerequisites, BOM import, and dependency examples for both WebFlux and Server MVC. Provide configuration examples for web-endpoint mapping, feature toggles, and local build/test commands, and update links for issues, docs, and contributing. Remove outdated badges/sections and simplify the license wording.
Add a new CONTRIBUTING.md with setup, testing, PR and community guidelines. Update README to remove Server MVC references and examples, narrow module list to WebFlux, relax JDK requirement to JDK 8+, adjust CI/test matrix and default test profile to spring-cloud-2021, and tidy documentation/Javadoc links.
@sonarqubecloud

Copy link
Copy Markdown

@mercyblitz
mercyblitz merged commit c3367aa into microsphere-projects:release-1.x May 27, 2026
54 of 62 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.

1 participant