docs: add Security & Quality Conventions to copilot-instructions.md - #43
Merged
Merged
Conversation
TheWitness
requested review from
bmfmancini and
xmacan
and
a lite review from Copilot
September 21, 2026 20:01
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
Documentation-only change with clear, accurate guidance and no functional impact.
Review effort: Lite
Findings: None
What changed in this PR
Adds a new documentation section to the repository’s Copilot instructions, capturing recurring security and quality patterns used across the Cacti plugin fleet to help keep future contributions consistent and safer.
Changes:
- Documented key security conventions (no hardcoded hosts, prepared statements, hardened
unserialize(), consistent i18n domain usage). - Documented preferred Cacti/plugin APIs (
html_escape_request_var(), idempotent plugin table-creation helpers). - Documented a standard PHPDoc block shape to encourage consistent function documentation.
| File | Description |
|---|---|
| .github/copilot-instructions.md | Adds a “Security & Quality Conventions” section describing established secure/consistent coding patterns. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
bmfmancini
approved these changes
Sep 21, 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 a "Security & Quality Conventions" section to
.github/copilot-instructions.md, documenting recurring patterns established across the Cacti plugin fleet:db_qstr()html_escape_request_var()overhtml_escape(get_request_var(...))unserialize()(allow_classes => false)api_plugin_db_table_create()/api_plugin_db_add_column()idempotent table-creation API@param, blank comment,@return)Documentation-only change, no functional/behavioral changes.