Skip to content

Add best practices disclaimer to readme - #388

Merged
swissspidy merged 1 commit into
mainfrom
add/readme-disclaimer
Jul 28, 2026
Merged

Add best practices disclaimer to readme#388
swissspidy merged 1 commit into
mainfrom
add/readme-disclaimer

Conversation

@swissspidy

@swissspidy swissspidy commented Jul 28, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Added guidance that wp scaffold is no longer recommended for modern WordPress plugin and theme development.
    • Directed readers to @wordpress/create-block for current build configurations and block theme support.
    • Updated the Post package description to include this guidance.

@swissspidy swissspidy added this to the 2.5.8 milestone Jul 28, 2026
@swissspidy
swissspidy requested a review from a team as a code owner July 28, 2026 09:30
@swissspidy swissspidy added the scope:documentation Related to documentation label Jul 28, 2026
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds WordPress scaffolding guidance to the README and disclaimer partial, and configures composer.json to source the disclaimer for the Post package description.

Changes

Scaffolding disclaimer

Layer / File(s) Summary
Disclaimer content and README wiring
README.md, .readme-partials/disclaimer.md, composer.json
Adds a note about wp scaffold, references @wordpress/create-block, and configures the Post package description to include the disclaimer partial.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: brianhenryie, ernilambar, janw-me

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding a best-practices disclaimer to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add/readme-disclaimer

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.readme-partials/disclaimer.md:
- Around line 1-2: Limit the disclaimer in .readme-partials/disclaimer.md lines
1-2 to block scaffolding, specifically replacing the broad plugin/theme wording
with guidance about wp scaffold block and `@wordpress/create-block`. Regenerate
README.md lines 6-7 from the updated partial so it reflects the same narrowed
scope.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c4f0e79e-6812-4ad9-b0a9-88c1a44feff5

📥 Commits

Reviewing files that changed from the base of the PR and between 10591dc and f086bd7.

📒 Files selected for processing (3)
  • .readme-partials/disclaimer.md
  • README.md
  • composer.json

Comment thread .readme-partials/disclaimer.md
@codecov

codecov Bot commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@swissspidy
swissspidy merged commit 18a6706 into main Jul 28, 2026
66 of 67 checks passed
@swissspidy
swissspidy deleted the add/readme-disclaimer branch July 28, 2026 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:documentation Related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants