From b079f471b713a40efac53d42cfed882da865f918 Mon Sep 17 00:00:00 2001 From: Jeff Gehlbach Date: Mon, 29 Apr 2024 18:10:34 -0400 Subject: [PATCH] "Full depth" sounds kind of unreasonable, doesn't it? --- Plugin-Certification-Program.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Plugin-Certification-Program.md b/Plugin-Certification-Program.md index 068471d..cf189d4 100644 --- a/Plugin-Certification-Program.md +++ b/Plugin-Certification-Program.md @@ -82,7 +82,7 @@ Every certified plugin's documentation and release notes must meet minimum crite - Brief installation instructions which do not assume deep user familiarity with plugins generally, and which when followed exactly will result in a functioning plugin. - A summary of where and how to engage with the plugin's maintainer team for bug reports, feature requests, and documentation requests (GitHub issues, Slack, etc.) - A summary of where and how to seek operational support as a user of the plugin (GitHub discussions, Slack, etc.) -- The plugin's main documentation must treat each of the points in the README in fuller depth. To minimize redundancy, linking into the main documentation from the top-level README is encouraged, particularly concerning the concise introduction. +- The plugin's main documentation must treat each of the points in the README in further depth. To minimize redundancy, linking into the main documentation from the top-level README is encouraged, particularly concerning the concise introduction. - Plugin documentation may not consist solely of a top-level README unless the plugin's scope is exceptionally small. - Plugin's release notes must open with a brief narrative summary characterizing it as a major, minor, or patch release and indicating whether it consists of bug fixes, new features, enhancements to existing features, or all of the above. - Any time a release introduces breaking changes, the release notes must include a bold header reading *Breaking Changes* under which a brief summary of each such change is provided, including links to each relevant issue.