docs: add Copilot instructions modeled on plugin_evidence - #3
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The reviewed guidance has unresolved documentation inaccuracies and omissions.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds repository-specific GitHub Copilot guidance for the Cacti Tags plugin.
Changes:
- Documents architecture, hooks, naming, security, and database conventions.
- Adds cleanup, upgrade, automatic-tag, and version-control guidance.
File summaries
| File | Summary | Findings |
|---|---|---|
.github/copilot-instructions.md |
Adds tailored Copilot instructions for the Tags plugin. | Five nit-level documentation issues remain regarding naming, cleanup, changelog guidance, paths, and upgrade wording. |
Review details
Suppressed comments (2)
.github/copilot-instructions.md:133
- The “CORRECT” cleanup example is incomplete: the actual
plugin_tags_remove_data()also deletes the plugin'ssettingsrows (setup.php:76-77), but this sample only drops the four tables. An assistant following this example can leave configuration behind; include the settings deletes here as well.
function plugin_tags_remove_data() {
db_execute('DROP TABLE IF EXISTS plugin_tags_event');
db_execute('DROP TABLE IF EXISTS plugin_tags_event_archive');
db_execute('DROP TABLE IF EXISTS plugin_tags_uptime');
db_execute('DROP TABLE IF EXISTS plugin_tags_state');
.github/copilot-instructions.md:85
plugin_tags_check_config()callsplugin_tags_upgrade(), butinclude/database.php:30-43does not perform an old/new version comparison: it always updates the plugin version and ensures the state table exists. Calling this a normal version check is misleading; describe it as upgrade/setup work unless the implementation is changed to gate upgrades on the old version.
`plugin_tags_check_config()` re-registers the `run_data_query` hook if missing (self-healing pattern) in addition to the normal `plugin_tags_upgrade()` version check — follow this same self-healing approach for any hook that might be silently missing after an upgrade.
- Files reviewed: 1/1 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…st to (int) for string output
bmfmancini
approved these changes
Sep 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds/aligns .github/copilot-instructions.md to follow the structure used in Cacti/plugin_evidence, tailored to this plugin's actual hooks, database tables, naming conventions, and security-sensitive areas.