Skip to content

WALKTHROUGH.md

Latest commit

 

History

History
34 lines (24 loc) · 1.64 KB

WALKTHROUGH.md

File metadata and controls

34 lines (24 loc) · 1.64 KB
Raw

Walkthrough - Template Conformance Updates

I have completed the review, optimization, and documentation of the template-conformance project.

Changes Verified

1. Code Optimization & Refactoring

  • Refactored Core Logic: Consolidated the check logic in template_conformance_core.py into a generic process_requirements function, reducing code duplication.
  • Parser Improvements: Updated EARSParser, RuppParser, and AgileUserStoryParser to implement a consistent analyze() interface.
  • Bug Fixes:
    • Fixed UnboundLocalError in ears_template_conformance.py and rupp_template_conformance.py where logical branches could leave variables undefined.
    • Updated agile_user_story_conformance.py to use the modern Spacy Matcher API (v3+).
    • Fixed import paths to support the current directory structure.

2. Dependency Management

  • Added requirements.txt with necessary dependencies (spacy, flask, flask-restful, marshmallow).

3. Documentation

  • README.md: Updated with clear installation and usage instructions.
  • DEVELOPER_GUIDE.md: Created a new guide describing the project structure, setup, and testing.

4. Verification

  • Created test_functionality.py to verify all three conformance checkers.
  • Successfully verified EARS, Rupp, and Agile template checks.

How to Verify Checks

You can run the included verification script:

python test_functionality.py

Expected output should show True for valid EARS and Agile sentences, and appropriate results for Rupp.