diff --git a/.github/ISSUE_TEMPLATE/comprehensive-codebase-review.yml b/.github/ISSUE_TEMPLATE/comprehensive-codebase-review.yml index d5de192..fc55a3b 100644 --- a/.github/ISSUE_TEMPLATE/comprehensive-codebase-review.yml +++ b/.github/ISSUE_TEMPLATE/comprehensive-codebase-review.yml @@ -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 (, , 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 (, , 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". - 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. Additional Instructions: diff --git a/.github/ISSUE_TEMPLATE/create-copilot-instructions.yml b/.github/ISSUE_TEMPLATE/create-copilot-instructions.yml index 3b3c5de..d1e0c01 100644 --- a/.github/ISSUE_TEMPLATE/create-copilot-instructions.yml +++ b/.github/ISSUE_TEMPLATE/create-copilot-instructions.yml @@ -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. validations: required: true @@ -34,7 +34,7 @@ body: label: Requirements description: Guidelines for creating the instructions value: | - - The `copilot-instructions.md` should be clear, concise, and easily adaptable for use in similar repositories. + - The `.github/copilot-instructions.md` should be clear, concise, and easily adaptable for use in similar repositories. - Review all configuration files, documentation, and code comments for relevant standards. - Highlight any repository-specific nuances. validations: