Revamp README and add new agent prompt templates#115
Merged
Conversation
Add six new agent prompt templates under .github/prompts to support common developer tasks: create-readme, document-api, explain-code, generate-unit-tests, onboarding-plan, and review-code. Also update README branch table entries: replace legacy 0.2.x/0.1.x labels with main and 1.x while preserving the Spring Boot compatibility and version references.
Update microsphere-spring.version in microsphere-spring-boot-parent/pom.xml from 0.1.16 to 0.1.17 to pick up the latest microsphere-spring release.
Rewrite and expand README.md to provide a full Table of Contents and detailed usage docs. Updates include a new modules matrix, examples for BOM/dependency usage, default properties, auto-config exclusion, bind listeners, actuator endpoints, monitored scheduler, and classpath artifact detection. Build and contribution instructions were clarified (prereqs, mvnw commands, install), the Codecov badge branch was switched to main, maintainers info was added, and the license link/path was updated. Overall this change replaces the previous terse overview with a comprehensive developer-facing guide.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
mercyblitz
merged commit 12eabb7
into
microsphere-projects:release-1.x
37 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds a set of prompt templates to the
.github/promptsdirectory to assist with common engineering tasks such as creating READMEs, generating OpenAPI specs, explaining code, writing unit tests, onboarding new team members, and performing code reviews. These templates are designed to standardize and streamline key workflows by providing clear instructions and requirements for each task.New prompt templates added:
README and Documentation Generation
create-readme.prompt.mdto guide the creation of comprehensive, developer-focused README files, including required sections, formatting guidelines, and content restrictions.document-api.prompt.mdfor generating OpenAPI 3.0 specifications, with detailed requirements for structure, validation, and example data.Code Understanding and Testing
explain-code.prompt.mdto produce beginner-friendly code explanations, including step-by-step breakdowns and examples.generate-unit-tests.prompt.mdto generate thorough, framework-specific unit tests for selected functions, covering core functionality, input validation, error handling, and side effects.Onboarding and Code Review
onboarding-plan.prompt.mdto provide a phased onboarding plan for new team members, with actionable steps and resource recommendations.review-code.prompt.mdto standardize comprehensive code reviews, outlining review areas and structured feedback format.