-
Notifications
You must be signed in to change notification settings - Fork 4
docs: add Copilot instructions modeled on plugin_evidence #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| # GitHub Copilot Instructions | ||
|
|
||
| ## Priority Guidelines | ||
|
|
||
| When generating code for this repository: | ||
|
|
||
| 1. **Version Compatibility**: This is a Cacti plugin (`quicktree`, version 2.0) targeting Cacti 1.2.17+ | ||
| 2. **Context Files**: Prioritize patterns and standards defined in this file (`.github/copilot-instructions.md`) | ||
| 3. **Codebase Patterns**: When context files don't provide specific guidance, scan the codebase for established patterns | ||
| 4. **Architectural Consistency**: Maintain plugin-based architecture extending Cacti core | ||
| 5. **Code Quality**: Prioritize security, maintainability, and compatibility in all generated code | ||
|
|
||
| ## Technology Stack | ||
|
|
||
| ### Core Technologies | ||
| - **PHP**: Compatible with Cacti 1.2.x supported versions | ||
| - **Platform**: Cacti Plugin Architecture ("QuickTree" - a shopping-basket style graph playlist) | ||
| - **Database**: MySQL/MariaDB | ||
|
|
||
| ### Key Dependencies | ||
| - Cacti core framework (`api_plugin_*`, `db_*`, `read_config_option()`) | ||
| - Client-side: `quicktree.js`, `quicktree.css` | ||
|
|
||
| ## Project Structure | ||
|
|
||
| ``` | ||
| quicktree/ # Repository root (install to plugins/quicktree/ in Cacti) | ||
| ├── images/ # UI icons | ||
| ├── locales/ # Internationalization files | ||
| ├── quicktree.css # Client-side styling | ||
| ├── quicktree.js # Client-side add/remove graph interactions | ||
| ├── quicktree.php # Main playlist view / management page | ||
| ├── INFO # Plugin metadata (name, version, compat) | ||
| ├── README.md | ||
| └── setup.php # Plugin install/uninstall/upgrade hooks | ||
| ``` | ||
|
|
||
| ## Naming Conventions | ||
|
|
||
| ### Function Names | ||
| - **Plugin lifecycle/hook-registration functions** MUST be prefixed `plugin_quicktree_`: `plugin_quicktree_install()`, `plugin_quicktree_upgrade()`, `plugin_quicktree_version()`. | ||
| - **All other functions** MUST be prefixed `quicktree_`: `quicktree_show_tab()`, `quicktree_page_location()`, `quicktree_setup_table()`. | ||
| - Match the existing prefix used by the function you are editing; do not introduce a third naming scheme. | ||
|
|
||
| ## Code Style | ||
|
|
||
| ### Indentation and Formatting | ||
| - **Tabs**: Use tabs (not spaces) for indentation throughout all PHP files. | ||
| - **Braces**: Opening brace on the same line for functions and control structures. | ||
| - **Spacing**: Space after control structure keywords (`if`, `foreach`, `while`). | ||
|
|
||
| ### File Headers | ||
| ALL PHP files MUST include the standard GPL v2 license header used throughout this repository (see `setup.php`), crediting "The Cacti Group" (and Howard Jones as original author). | ||
|
|
||
| ## Security Standards | ||
|
|
||
| ### SQL Query Security | ||
| Use prepared statements for anything involving variable input: | ||
|
|
||
| ```php | ||
| // CORRECT | ||
| db_fetch_row_prepared('SELECT * FROM plugin_quicktree_items WHERE id = ?', array($id)); | ||
|
|
||
| // WRONG - never do this with request-derived values | ||
| db_fetch_row("SELECT * FROM plugin_quicktree_items WHERE id = $id"); | ||
| ``` | ||
|
|
||
| ### Input Validation | ||
| Use `get_filter_request_var()` / `get_nfilter_request_var()` for request input; never read `$_GET`/`$_POST` directly. Validate `api_user_realm_auth('quicktree.php')` before rendering the tab or management actions. | ||
|
|
||
| `get_filter_request_var()` (and its `gfrv()` shorthand, where available) called with only the | ||
| `$name` argument (no regex/filter as the 2nd/3rd argument) already validates the value as numeric | ||
| and returns it as a **string** -- it does not return an int, and it halts execution if the request | ||
| value is not numeric. Because of this, do NOT cast its output to `(int)` when the result is only | ||
| used for string output (e.g. `print`/`echo`, string concatenation, embedding in HTML/JS); the cast | ||
| is redundant. Only cast when the value is genuinely used in an integer/numeric context (e.g. | ||
| arithmetic, strict `===` comparisons). | ||
|
|
||
| ## Database Operations | ||
|
|
||
| ### Upgrade Handling | ||
| Version-gate schema changes in `quicktree_check_upgrade()` (`setup.php`) against the stored `plugin_config` row. | ||
|
|
||
| ## Internationalization | ||
|
|
||
| ALL user-facing strings MUST use `__()`/`__esc()` with the `'quicktree'` text domain: | ||
|
|
||
| ```php | ||
| print '<img ... alt="' . __esc('Quicktree', 'quicktree') . '">'; | ||
| ``` | ||
|
|
||
| ## Plugin Architecture | ||
|
|
||
| ### Plugin Hooks | ||
| Register all plugin hooks in `plugin_quicktree_install()` (`setup.php`): | ||
|
|
||
| ```php | ||
| api_plugin_register_hook('quicktree', 'top_header_tabs', 'quicktree_show_tab', 'setup.php'); | ||
| api_plugin_register_hook('quicktree', 'top_graph_header_tabs', 'quicktree_show_tab', 'setup.php'); | ||
| api_plugin_register_hook('quicktree', 'config_arrays', 'quicktree_config_arrays', 'setup.php'); | ||
| api_plugin_register_hook('quicktree', 'config_settings', 'quicktree_config_settings', 'setup.php'); | ||
| api_plugin_register_hook('quicktree', 'draw_navigation_text', 'quicktree_draw_navigation_text', 'setup.php'); | ||
| api_plugin_register_hook('quicktree', 'graph_buttons', 'quicktree_graph_buttons', 'setup.php'); | ||
| api_plugin_register_hook('quicktree', 'graph_buttons_thumbnails', 'quicktree_graph_buttons', 'setup.php'); | ||
| api_plugin_register_hook('quicktree', 'page_head', 'quicktree_page_head', 'setup.php'); | ||
|
|
||
| api_plugin_register_realm('quicktree', 'quicktree.php', __('QuickTree Management', 'quicktree'), 1); | ||
| ``` | ||
|
|
||
| ### Page Placement Setting | ||
| `quicktree_page_location()` honors the `quicktree_pagestyle` setting (Tab / Console Menu / Both) — when adding new entry points, respect this same placement logic rather than hardcoding a tab-only or menu-only presentation. | ||
|
|
||
| ## Best Practices | ||
|
|
||
| 1. Always guard tab/UI rendering with `api_user_realm_auth('quicktree.php')`. | ||
| 2. Respect the `quicktree_pagestyle` setting for any new navigation entry point. | ||
| 3. Wrap all user-facing strings with `__()`/`__esc()` and the `quicktree` domain. | ||
|
|
||
| ## Common Pitfalls to Avoid | ||
|
|
||
| ```php | ||
| // WRONG - unescaped output in an alt attribute | ||
| print '<img alt="' . $label . '">'; | ||
|
|
||
| // CORRECT | ||
| print '<img alt="' . __esc($label, 'quicktree') . '">'; | ||
| ``` | ||
|
|
||
| ## Version Control | ||
|
|
||
| Document all changes in `CHANGELOG.md`; use descriptive commit messages referencing issue/PR numbers when applicable. | ||
|
TheWitness marked this conversation as resolved.
|
||
|
|
||
| ## References | ||
|
|
||
| - [Cacti main repo](https://github.com/Cacti/cacti/tree/1.2.x) | ||
| - [Cacti Documentation](https://www.github.com/Cacti/documentation) | ||
| - `README.md` for feature descriptions | ||
| - `CHANGELOG.md` for version history | ||
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.
Uh oh!
There was an error while loading. Please reload this page.