Skip to content

Add help text for YARA scan plugin fields#632

Open
anshikaagr wants to merge 1 commit into
utksh1:mainfrom
anshikaagr:fix-yara-help-text
Open

Add help text for YARA scan plugin fields#632
anshikaagr wants to merge 1 commit into
utksh1:mainfrom
anshikaagr:fix-yara-help-text

Conversation

@anshikaagr
Copy link
Copy Markdown

Description

Added missing field-level help text to the YARA scan plugin metadata to improve guidance in the generated UI.

Changes

  • Added help text for the YARA Rules Path field explaining the expected .yar / .yara rule file input.
  • Added help text for the Print Matching Strings field explaining that matching strings from triggered YARA rules will be included in the scan output.
  • Refreshed the plugin checksum after updating metadata.

Related Issues

Issue #536

Type of Change

  • Documentation update

How Has This Been Tested?

  • Verified the metadata file contains help text for all user-facing fields.
  • Refreshed the plugin checksum using:
python scripts/refresh_plugin_checksum.py --plugin yara_scan
  • Confirmed the metadata structure remains valid and the plugin configuration loads correctly.

Checklist

  • My code follows the code style of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

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