Skip to content

Improve GitHub and WordPress.org plugin copy#186

Open
jdevalk wants to merge 5 commits intodevelopfrom
jdv/optimize-github-and-wp-readme
Open

Improve GitHub and WordPress.org plugin copy#186
jdevalk wants to merge 5 commits intodevelopfrom
jdv/optimize-github-and-wp-readme

Conversation

@jdevalk
Copy link
Member

@jdevalk jdevalk commented Mar 16, 2026

Summary

  • improve the GitHub-facing readme and repo presentation
  • improve the WordPress.org readme for clarity, discovery, and conversion
  • refresh support, contribution, and security docs to match current branding and links

Testing

  • not needed (copy/docs only)

@github-actions
Copy link

github-actions bot commented Mar 16, 2026

Test on Playground
Test this pull request on the Playground
or download the zip

@github-actions
Copy link

github-actions bot commented Mar 16, 2026

🔍 WordPress Plugin Check Report

⚠️ Status: Passed with warnings

📊 Report

🎯 Total Issues ❌ Errors ⚠️ Warnings
1 0 1

⚠️ Warnings (1)

📁 comment-hacks.php (1 warning)
📍 Line 🔖 Check 💬 Message
0 textdomain_mismatch The "Text Domain" header in the plugin file does not match the slug. Found "yoast-comment-hacks", expected "comment-hacks".

🤖 Generated by WordPress Plugin Check Action • Learn more about Plugin Check

@ilicfilip ilicfilip self-requested a review March 16, 2026 13:23
Copy link
Contributor

@ilicfilip ilicfilip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have 2 SECURITY.md files with the same content now - one in the root and the other in the .github directory.

Other than that it looks good.

@jdevalk
Copy link
Member Author

jdevalk commented Mar 16, 2026

Removed the redundant SECURITY.md

@jdevalk jdevalk requested a review from tacoverdo March 16, 2026 14:40
Copy link

@tacoverdo tacoverdo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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.

3 participants