Conversation
oddly these failed for me during the 0.3.0 release, so updating here to capital WP
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Updated section headings and added examples for clarity in the Experiment lifecycle documentation.
Co-authored-by: Dovid Levine <justlevine@gmail.com>
Added note about potential breaking changes to experiments. Co-authored-by: justlevine <justlevine@git.wordpress.org>
Added guidelines for AI-driven feature proposals, including validation, testing, and ethical considerations.
|
@justlevine anything else you think should be called out in the changes here or otherwise good to go? |
justlevine
left a comment
There was a problem hiding this comment.
Content-wise I'm feeling good, flagged a numbering nit
Co-authored-by: Dovid Levine <justlevine@gmail.com>
Co-authored-by: Dovid Levine <justlevine@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #219 +/- ##
==========================================
Coverage 56.76% 56.76%
Complexity 505 505
==========================================
Files 32 32
Lines 2565 2565
==========================================
Hits 1456 1456
Misses 1109 1109
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
What?
This PR adds some docs (and tidies up existing docs in a couple places) to generally cover questions that @justlevine asked in #75. While I don't expect we'll need to consider how an Experiment graduates OUT of the AI Experiments plugin towards core in the near-to-medium future, I still went ahead and tried to describe how that likely would work. Documenting how a new Experiment lands in the AI Experiments plugin definitely felt worthwhile, so that's here too. Finally I tried to make sure the repo properly covered items as outlined in @desrosj's Criteria for Creating or Migrating Repositories under the WordPress GitHub Organization post (albeit delayed in updating for that but its done now in any case).
Closes #75.
Copilot Summary
This pull request improves documentation for the AI Experiments plugin by adding a new guide describing the experiment lifecycle, updating references to this new documentation throughout the project, and enhancing the README and release instructions for clarity and accuracy.
Documentation improvements:
EXPERIMENT_LIFECYCLE.mddocument detailing how experiments are proposed, reviewed, included in the plugin, and potentially graduate to WordPress core.CONTRIBUTING.mdanddocs/DEVELOPER_GUIDE.mdto reference the new experiment lifecycle documentation, helping contributors understand the process for proposing and evolving experiments. [1] [2]README and feature descriptions:
README.mdwith a "Current Features" section listing and describing the main plugin features, and added a link to the Credits file for contributor recognition. [1] [2]README.mdandreadme.txtto specify that it creates a feature image from post content in the block editor. [1] [2]Release instructions and minor fixes:
docs/RELEASE_INSTRUCTIONS.mdto use the correct GitHub organization casing and URLs, ensuring consistency and accuracy in release documentation. [1] [2]docs/TESTING_REST_API.md.Why?
How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast