fix(spp_hazard_programs)

[gonzalesedwin1123]

Summary

• Updated readme/DESCRIPTION.md to accurately reflect the codebase: fixed menu paths ("Hazard and Emergency" not "Hazard & Emergency"), listed actual field names in key models table, documented
  ribbon/stat buttons/list view columns, and noted auto_install behavior
• Added readme/USAGE.md with 9 step-by-step UI test scenarios for QA covering: program-incident linking, emergency flag by status, damage level filtering, stat button navigation, incident-side views,
  bidirectional relationships, list view columns, and search filters
• Regenerated README.rst and static/description/index.html via OCA toolchain

Test plan

• All 24 existing tests pass
• Pre-commit checks pass
• README.rst regenerated cleanly (no manual edits)
• QA team walks through the 9 UI test scenarios in USAGE.md against a running instance

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation and testability of the spp_hazard_programs module. It provides clearer explanations of module functionalities and introduces comprehensive UI test scenarios, making it easier for users to understand the system and for QA to validate its behavior.

Highlights

• Documentation Updates: Updated readme/DESCRIPTION.md to reflect current codebase details, including correct menu paths, explicit field names, and documented UI elements like stat buttons and list view columns.
• New UI Test Scenarios: Introduced readme/USAGE.md with nine detailed UI test scenarios to guide QA in verifying program-incident linking, emergency flag behavior, damage level filtering, and UI navigation.
• README Regeneration: Regenerated README.rst and static/description/index.html to synchronize with the updated documentation and remove outdated elements.

Changelog

• spp_hazard_programs/README.rst
  • Removed the Odoo Community Association banner image.
  • Updated the module's description to include auto_install behavior.
  • Expanded "Key Capabilities" to detail is_emergency_program flag computation, is_emergency_mode toggle, and stat button navigation.
  • Provided explicit field names for spp.program and spp.hazard.incident in "Key Models".
  • Corrected UI menu paths (e.g., "Hazard and Emergency" instead of "Hazard & Emergency").
  • Added "List views" section under "UI Location" to describe new columns.
  • Clarified security inheritance for added fields.
  • Added a new "Usage" section with detailed prerequisites and 9 UI test scenarios.
• spp_hazard_programs/readme/DESCRIPTION.md
  • Updated the module's introductory description to include auto_install behavior.
  • Revised "Key Capabilities" to provide more specific details on emergency flag computation, damage level filtering, and UI navigation.
  • Specified exact field names for extended models (spp.program, spp.hazard.incident) in "Key Models".
  • Corrected UI menu paths and added descriptions for list view columns under "UI Location".
  • Clarified security information regarding new fields inheriting access.
• spp_hazard_programs/readme/USAGE.md
  • Added a new file containing a comprehensive guide for testing the module.
  • Included prerequisites for setting up the test environment.
  • Detailed 9 step-by-step UI test scenarios covering various functionalities like program-incident linking, emergency flag logic, damage level filtering, stat button navigation, bidirectional relationships, and list view/search filters.
• spp_hazard_programs/static/description/index.html
  • Updated the HTML title to "OpenSPP Hazard Programs Integration".
  • Removed the Odoo Community Association banner image and associated HTML.
  • Synchronized content with the updated README.rst, including expanded descriptions, model details, UI locations, and the new "Usage" section with test scenarios.

Activity

• The author confirmed that all 24 existing tests passed successfully.
• Pre-commit checks were verified to pass without issues.
• The README.rst file was regenerated cleanly, indicating no manual edits were required.
• The QA team is scheduled to review the 9 new UI test scenarios outlined in USAGE.md against a running instance.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request provides a comprehensive update to the module's documentation. The DESCRIPTION.md has been revised for accuracy, now including specific field names, corrected UI paths, and details on new features like the emergency ribbon and list view columns. A new USAGE.md file has been introduced, offering detailed, step-by-step UI test scenarios that will be invaluable for QA. The README.rst and index.html files have been regenerated to reflect these improvements. Overall, these changes significantly enhance the clarity, accuracy, and testability of the documentation.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.76%. Comparing base (93fa4cb) to head (7813278).

Additional details and impacted files

@@           Coverage Diff           @@
##             19.0     #110   +/-   ##
=======================================
  Coverage   70.76%   70.76%           
=======================================
  Files         682      682           
  Lines       37347    37347           
=======================================
  Hits        26429    26429           
  Misses      10918    10918           

Flag	Coverage Δ
spp_base_common	90.26% <ø> (ø)
spp_hazard_programs	97.14% <ø> (ø)
spp_programs	45.51% <ø> (ø)
spp_security	66.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.