Skip to content

documentation: add community files and a social preview image - #103

Merged
mukeshpanchal27 merged 1 commit into
trunkfrom
documentation/community-files
Nov 4, 2026
Merged

mukeshpanchal27 merged 1 commit into
trunkfrom
documentation/community-files

Conversation

@mukeshpanchal27

Copy link
Copy Markdown
Owner

Change

SECURITY.md:

  • Which versions get fixes: only the latest 1.x release.
  • How to report a problem privately, with the Report a vulnerability button. I turned on private vulnerability reporting for the repo, so the button exists now.
  • What counts as a security problem for this plugin, and what does not. Timing data and file paths shown to the administrator are the purpose of the plugin.
  • A link to docs/security-review.md.

CONTRIBUTING.md: setup with npm ci, Composer and wp-env, plus:

  • branch names, commit message types and the PR template
  • the commands to run before a PR, and a table of the required checks
  • the npm exec --no -- rule
  • the rule to pin actions to commit hashes, with exact tag comments

CODE_OF_CONDUCT.md: the Contributor Covenant 2.0, taken word for word from GitHub's codes of conduct API.

  • It has one placeholder for the contact method. I filled it with your GitHub profile, not an email address, because I did not want to publish your email without asking.
  • If you want people to report by email, change line 63.

Social preview:

  • .github/social-preview.png is 1280x640, the size GitHub recommends. It uses the same design as the wordpress.org banner.
  • bin/make-wordpress-org-assets.js renders it from bin/assets/social-preview.html.
  • It lives in .github/, not .wordpress-org/, because the deploy copies .wordpress-org/ to wordpress.org.
  • GitHub has no API for this image, so it must be uploaded by hand in Settings > General > Social preview.

Release files: .distignore now leaves out the three new Markdown files. I rebuilt the zip, and none of them were in it.

README: the Documentation section links the three new files.

🤖 Generated with Claude Code

Add a security policy, a contributing guide and the Contributor
Covenant code of conduct. Add a GitHub social preview image, made by
the asset script. Keep the new files out of the release.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

✅ WordPress Plugin Check Report

✅ Status: Passed

📊 Report

All checks passed! No errors or warnings found.


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

@mukeshpanchal27
mukeshpanchal27 merged commit b1bb0fb into trunk Nov 4, 2026
14 checks passed
@mukeshpanchal27
mukeshpanchal27 deleted the documentation/community-files branch November 4, 2026 05:26
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