Skip to content

Substantial Refactor of Market Health Reporter Prompts for Quality, Structure, and Reviewability #488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

Brijeshthummar02
Copy link

Fixes #427

Overview

This PR delivers a comprehensive, hand-crafted refactor of the Market Health Reporter prompt system, with the goal of improving the clarity, structure, and actionable quality of automated market anomaly reports. All changes are based on a careful review of the original prompt logic, your contribution guidelines, and best practices for LLM prompt engineering---no LLM-generated rewrites were used.

Key Improvements

  • Explicit Output Structure:

    • Added a required YAML front matter and article body format, with clear field requirements and tag usage.
    • Ensures all LLM outputs are consistent, reviewable, and ready for publication.
  • Step-by-Step Analytical Guidance:

    • Reorganized instructions into a logical, actionable sequence for the LLM.
    • Clarified how to handle both anomalous and non-anomalous cases, with a focus on evidence and conciseness.
  • Benchmark-Driven Analysis:

    • Retained and highlighted all original metric benchmarks and anomaly criteria.
    • Required the use of quantitative evidence and specific metric references in the report.
  • Maintainability and Transparency:

    • Added inline comments and sectioning to explain the rationale for each change.
    • Improved logical flow and removed redundancy for easier future updates.
  • Strict Adherence to Guidelines:

    • Output is now strictly based on provided data---no speculation or unsupported claims.
    • Only allows illustration placeholders that match project standards.

Methodology

  • All changes were made manually, with a focus on code quality, maintainability, and reviewer experience.
  • The refactor is designed to reduce ambiguity, enforce best practices, and make the review process more efficient for maintainers.
  • The new prompt structure will help contributors produce higher-quality, guideline-compliant reports and reduce the need for reviewer intervention.

…tructure, and Reviewability

Signed-off-by: Brijeshthummar02 <[email protected]>
@Brijeshthummar02
Copy link
Author

@evgenydmitriev i tried my best this time.

@evgenydmitriev
Copy link
Contributor

duplicate of #487

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.

Improve Market Health Reporter Prompts
2 participants