-
Notifications
You must be signed in to change notification settings - Fork 0
Copilot instruction and chi compliance clarifications #15
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
base: main
Are you sure you want to change the base?
Changes from all commits
0986d1b
bf5d3b2
69f3bf2
61e6855
4b85bdf
266b907
b0cd262
2c28650
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -137,7 +137,13 @@ body: | |||||||||||||||||||||
| - scoring.md — tabular scoring with 1-10 ratings and justifications. | ||||||||||||||||||||||
| - architecture.mmd — Mermaid diagram source for the architecture. | ||||||||||||||||||||||
| - improvement-issues.md — synopsis of open improvement-focused GitHub issues with solution steps. | ||||||||||||||||||||||
| - chi-compliance.md — generated only when the repository includes a Vue-based UI; evaluate every view, page, and component for adherence to the Chi design system (https://assets.ctl.io/chi/5.78.0/getting-started/?theme=Portal) using any of these valid implementation patterns: 1. Chi HTML Blueprint - Using Chi CSS classes (.chi-data-table, .chi-button, etc.) with proper HTML/div structure as documented at https://assets.ctl.io/chi/5.78.0/getting-started/ 2. Chi Web Components - Using Chi's custom elements (<chi-button>, <chi-modal>, etc.) 3. Chi Vue Components - Using Vue wrappers from @centurylink/chi-vue package (ChiDataTable, ChiButton, etc.). Score compliance based on correct usage of ANY of these patterns. Flag as non-compliant only when components bypass Chi entirely with custom implementations. For partially compliant components, note when a component uses one Chi pattern (e.g., CSS classes) but could benefit from a higher-level pattern (e.g., Vue component) for better maintainability, catalog deviations, and prioritize remediation steps before upgrading the Chi version. Generate a score 1-10 for this as well. | ||||||||||||||||||||||
| - chi-compliance.md — generated only when the repository includes a Vue-based UI; | ||||||||||||||||||||||
| * FIRST, check index.html for Chi CDN references (CSS/JS URLs) - this is the authoritative Chi version | ||||||||||||||||||||||
| * Report the Chi version from index.html CDN URLs (e.g., https://lib.lumen.com/chi/5.78.0/chi-portal.css) | ||||||||||||||||||||||
| * Explicitly state Chi is CDN-loaded, NOT an npm package | ||||||||||||||||||||||
| * Report the exact @centurylinkfederal/eis-vue version from package-lock.json by searching for "node_modules/@centurylinkfederal/eis-vue" and extracting the "version" field | ||||||||||||||||||||||
| * Include both npm package versions (@centurylink/chi-vue) and the CDN-loaded Chi version separately | ||||||||||||||||||||||
| * evaluate every view, page, and component for adherence to the Chi design system (https://assets.ctl.io/chi/5.78.0/getting-started/?theme=Portal) using any of these valid implementation patterns: 1. Chi HTML Blueprint - Using Chi CSS classes (.chi-data-table, .chi-button, etc.) with proper HTML/div structure as documented at https://assets.ctl.io/chi/5.78.0/getting-started/ 2. Chi Web Components - Using Chi's custom elements (<chi-button>, <chi-modal>, etc.) 3. Chi Vue Components - Using Vue wrappers from @centurylink/chi-vue package (ChiDataTable, ChiButton, etc.). Score compliance based on correct usage of ANY of these patterns. Flag as non-compliant only when components bypass Chi entirely with custom implementations. For partially compliant, note when a component uses one Chi pattern (e.g., CSS classes) but could benefit from a higher-level pattern (e.g., Vue component) for better maintainability., catalog deviations, and prioritize remediation steps before upgrading the Chi version. Generate a score 1-10 for this as well. In the package.json also ensure the semver reference to @centurylinkfederal/eis-vue is using ~ instead of ^ to ensure only patch versions are updated to avoid minor version change issues, for example correct is "@centurylinkfederal/eis-vue": "~1.2.148" and incorrect is "@centurylinkfederal/eis-vue": "^1.2.148". | ||||||||||||||||||||||
|
Comment on lines
+140
to
+146
|
||||||||||||||||||||||
| - chi-compliance.md — generated only when the repository includes a Vue-based UI; | |
| * FIRST, check index.html for Chi CDN references (CSS/JS URLs) - this is the authoritative Chi version | |
| * Report the Chi version from index.html CDN URLs (e.g., https://lib.lumen.com/chi/5.78.0/chi-portal.css) | |
| * Explicitly state Chi is CDN-loaded, NOT an npm package | |
| * Report the exact @centurylinkfederal/eis-vue version from package-lock.json by searching for "node_modules/@centurylinkfederal/eis-vue" and extracting the "version" field | |
| * Include both npm package versions (@centurylink/chi-vue) and the CDN-loaded Chi version separately | |
| * evaluate every view, page, and component for adherence to the Chi design system (https://assets.ctl.io/chi/5.78.0/getting-started/?theme=Portal) using any of these valid implementation patterns: 1. Chi HTML Blueprint - Using Chi CSS classes (.chi-data-table, .chi-button, etc.) with proper HTML/div structure as documented at https://assets.ctl.io/chi/5.78.0/getting-started/ 2. Chi Web Components - Using Chi's custom elements (<chi-button>, <chi-modal>, etc.) 3. Chi Vue Components - Using Vue wrappers from @centurylink/chi-vue package (ChiDataTable, ChiButton, etc.). Score compliance based on correct usage of ANY of these patterns. Flag as non-compliant only when components bypass Chi entirely with custom implementations. For partially compliant, note when a component uses one Chi pattern (e.g., CSS classes) but could benefit from a higher-level pattern (e.g., Vue component) for better maintainability., catalog deviations, and prioritize remediation steps before upgrading the Chi version. Generate a score 1-10 for this as well. In the package.json also ensure the semver reference to @centurylinkfederal/eis-vue is using ~ instead of ^ to ensure only patch versions are updated to avoid minor version change issues, for example correct is "@centurylinkfederal/eis-vue": "~1.2.148" and incorrect is "@centurylinkfederal/eis-vue": "^1.2.148". | |
| - chi-compliance.md — generated only when the repository includes a Vue-based UI; first, check index.html for Chi CDN references (CSS/JS URLs) and treat this as the authoritative Chi version; report the Chi version from index.html CDN URLs (e.g., https://lib.lumen.com/chi/5.78.0/chi-portal.css); explicitly state that Chi is CDN-loaded, not an npm package; report the exact @centurylinkfederal/eis-vue version from package-lock.json by searching for "node_modules/@centurylinkfederal/eis-vue" and extracting the "version" field; include both npm package versions (@centurylink/chi-vue) and the CDN-loaded Chi version separately; evaluate every view, page, and component for adherence to the Chi design system (https://assets.ctl.io/chi/5.78.0/getting-started/?theme=Portal) using any of these valid implementation patterns: (1) Chi HTML Blueprint – using Chi CSS classes (.chi-data-table, .chi-button, etc.) with proper HTML/div structure as documented at https://assets.ctl.io/chi/5.78.0/getting-started/, (2) Chi Web Components – using Chi's custom elements (<chi-button>, <chi-modal>, etc.), or (3) Chi Vue Components – using Vue wrappers from the @centurylink/chi-vue package (ChiDataTable, ChiButton, etc.); score compliance based on correct usage of any of these patterns, flag as non-compliant only when components bypass Chi entirely with custom implementations, and for partially compliant cases note when a component uses one Chi pattern (e.g., CSS classes) but could benefit from a higher-level pattern (e.g., Vue component) for better maintainability; catalog deviations and prioritize remediation steps before upgrading the Chi version; generate a score 1-10 for this as well; and in package.json ensure the semver reference to @centurylinkfederal/eis-vue uses ~ instead of ^ so that only patch versions are updated (for example, correct is "@centurylinkfederal/eis-vue": "~1.2.148" and incorrect is "@centurylinkfederal/eis-vue": "^1.2.148"). |
Copilot
AI
Feb 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The text "For partially compliant," is missing the word "components" after "compliant". It should read "For partially compliant components," to be grammatically correct and clear.
| * evaluate every view, page, and component for adherence to the Chi design system (https://assets.ctl.io/chi/5.78.0/getting-started/?theme=Portal) using any of these valid implementation patterns: 1. Chi HTML Blueprint - Using Chi CSS classes (.chi-data-table, .chi-button, etc.) with proper HTML/div structure as documented at https://assets.ctl.io/chi/5.78.0/getting-started/ 2. Chi Web Components - Using Chi's custom elements (<chi-button>, <chi-modal>, etc.) 3. Chi Vue Components - Using Vue wrappers from @centurylink/chi-vue package (ChiDataTable, ChiButton, etc.). Score compliance based on correct usage of ANY of these patterns. Flag as non-compliant only when components bypass Chi entirely with custom implementations. For partially compliant, note when a component uses one Chi pattern (e.g., CSS classes) but could benefit from a higher-level pattern (e.g., Vue component) for better maintainability., catalog deviations, and prioritize remediation steps before upgrading the Chi version. Generate a score 1-10 for this as well. In the package.json also ensure the semver reference to @centurylinkfederal/eis-vue is using ~ instead of ^ to ensure only patch versions are updated to avoid minor version change issues, for example correct is "@centurylinkfederal/eis-vue": "~1.2.148" and incorrect is "@centurylinkfederal/eis-vue": "^1.2.148". | |
| * evaluate every view, page, and component for adherence to the Chi design system (https://assets.ctl.io/chi/5.78.0/getting-started/?theme=Portal) using any of these valid implementation patterns: 1. Chi HTML Blueprint - Using Chi CSS classes (.chi-data-table, .chi-button, etc.) with proper HTML/div structure as documented at https://assets.ctl.io/chi/5.78.0/getting-started/ 2. Chi Web Components - Using Chi's custom elements (<chi-button>, <chi-modal>, etc.) 3. Chi Vue Components - Using Vue wrappers from @centurylink/chi-vue package (ChiDataTable, ChiButton, etc.). Score compliance based on correct usage of ANY of these patterns. Flag as non-compliant only when components bypass Chi entirely with custom implementations. For partially compliant components, note when a component uses one Chi pattern (e.g., CSS classes) but could benefit from a higher-level pattern (e.g., Vue component) for better maintainability., catalog deviations, and prioritize remediation steps before upgrading the Chi version. Generate a score 1-10 for this as well. In the package.json also ensure the semver reference to @centurylinkfederal/eis-vue is using ~ instead of ^ to ensure only patch versions are updated to avoid minor version change issues, for example correct is "@centurylinkfederal/eis-vue": "~1.2.148" and incorrect is "@centurylinkfederal/eis-vue": "^1.2.148". |
Copilot
AI
Feb 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "Logging issues found within tests should still mentioned" is missing the word "be" before "mentioned". It should read "should still be mentioned" to be grammatically correct.
| - logging-review.md — generated only when the repository contains Java code; inspect logging usage for noisy or frivolous events, confirm true exceptions include full stack context, and flag swallowed errors. Generate a score 1-10 for this as well. Logging issues found within tests should still mentioned at the bottom of the artifact, but not prioritized. | |
| - logging-review.md — generated only when the repository contains Java code; inspect logging usage for noisy or frivolous events, confirm true exceptions include full stack context, and flag swallowed errors. Generate a score 1-10 for this as well. Logging issues found within tests should still be mentioned at the bottom of the artifact, but not prioritized. |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,7 +11,7 @@ body: | |||||
| label: Request | ||||||
| description: Purpose of this issue | ||||||
| value: | | ||||||
| Please create a `copilot-instructions.md` file for this repository. The instructions should be generated based on a thorough analysis of the entire codebase and should provide clear, actionable guidance for GitHub Copilot and future contributors. | ||||||
| Please create a `copilot-instructions.md` file for this repository under the '.github' root directory. The instructions should be generated based on a thorough analysis of the entire codebase and should provide clear, actionable guidance for GitHub Copilot and future contributors. If a copilot-instructions.md file already exists elsewhere (like in the root of the repo) use it as a basis, update it, and move it under the '.github' folder. | ||||||
|
||||||
| Please create a `copilot-instructions.md` file for this repository under the '.github' root directory. The instructions should be generated based on a thorough analysis of the entire codebase and should provide clear, actionable guidance for GitHub Copilot and future contributors. If a copilot-instructions.md file already exists elsewhere (like in the root of the repo) use it as a basis, update it, and move it under the '.github' folder. | |
| Please create a `copilot-instructions.md` file for this repository under the '.github' directory. The instructions should be generated based on a thorough analysis of the entire codebase and should provide clear, actionable guidance for GitHub Copilot and future contributors. If a copilot-instructions.md file already exists elsewhere (like in the root of the repo) use it as a basis, update it, and move it under the '.github' folder. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 146 is extremely long and combines multiple distinct concerns (evaluation patterns, compliance scoring, remediation steps, and semver requirements) into a single run-on sentence. This makes the instructions difficult to parse and maintain. Consider breaking this into separate bullet points for each concern: one for evaluation patterns, one for scoring compliance, one for remediation steps, and one for package.json semver requirements.