Skip to content

Conversation

@jeffpaul
Copy link
Member

@jeffpaul jeffpaul commented Jan 16, 2026

Updated the readme file to reflect the latest version and features of ClassifAI.

Description of the Change

This pull request updates the plugin documentation to improve clarity, organization, and security reporting instructions. The most significant changes are the addition of a security bug reporting section and restructuring of the readme.txt file using standard WordPress formatting.

Documentation improvements:

  • Added a new section to both README.md and readme.txt explaining how to report security bugs via the Patchstack Vulnerability Disclosure Program, including a direct link and description of the process. [1] [2]
  • Introduced a "Frequently Asked Questions" section in readme.txt to house the new security reporting instructions, making it easier for users to find important information.

Readme formatting and structure:

  • Updated headings in readme.txt from Markdown-style (e.g., **Features**) to WordPress standard formatting (e.g., == Features ==, == Requirements ==) for improved compatibility and readability. [1] [2]
  • Added a blank line after the last changelog entry in readme.txt to maintain consistent formatting.

How to test the Change

Changelog Entry

Developer - Add Patchstack security-reporting FAQ.

Credits

Props @jeffpaul.

Checklist:

Updated the readme file to reflect the latest version and features of ClassifAI.
@jeffpaul jeffpaul added this to the 3.8.0 milestone Jan 16, 2026
@jeffpaul jeffpaul self-assigned this Jan 16, 2026
Added a section for reporting security bugs in the plugin.
@jeffpaul jeffpaul changed the title Revise readme.txt for patchstack faq Revise readmes for patchstack faq Jan 16, 2026
@jeffpaul jeffpaul marked this pull request as ready for review January 16, 2026 21:05
@jeffpaul jeffpaul requested review from a team and dkotter as code owners January 16, 2026 21:05
@github-actions github-actions bot added the needs:code-review This requires code review. label Jan 16, 2026
@jeffpaul jeffpaul merged commit e0f2200 into develop Jan 16, 2026
9 of 12 checks passed
@jeffpaul jeffpaul deleted the add/patchstack-faq branch January 16, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs:code-review This requires code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant