Skip to content

feat: Add GitHub Copilot Coding Agent configs#389

Merged
DaveSkender merged 19 commits intomainfrom
copilot/fix-388
Jun 4, 2025
Merged

feat: Add GitHub Copilot Coding Agent configs#389
DaveSkender merged 19 commits intomainfrom
copilot/fix-388

Conversation

Copy link
Contributor

Copilot AI commented Jun 4, 2025

This PR optimizes the repository for GitHub Copilot Coding Agent usage by implementing comprehensive documentation, templates, and automation following GitHub's best practices.

🎯 What's Changed

Issue & PR Templates

  • Added structured issue templates for bug reports, feature requests, and questions
  • Created comprehensive pull request template with checklists and guidelines
  • Configured issue template settings with helpful contact links

Enhanced Documentation

  • Added status badges for build, deploy, CodeQL, license, and community metrics
  • Expanded README with detailed build/test instructions and contributor quick start
  • Enhanced CONTRIBUTING.md with:
    • Branch naming conventions and commit message standards
    • Complete label taxonomy for better issue organization
    • Dependency update handling procedures
    • Security alert response protocols
    • GitHub Copilot optimization guidelines

Automated Workflows

  • Added CodeQL security scanning for C# and JavaScript
  • Created Dependabot configuration for .NET, npm, and GitHub Actions dependencies
  • Verified and documented existing CI/CD pipeline clarity

Repository Organization

  • Documented primary development branch (main) and workflow
  • Defined project board structure and usage guidelines
  • Established clear access and permission documentation
  • Added repository structure guide for AI understanding

Security & Quality

  • Implemented automated code scanning with CodeQL
  • Documented secret scanning best practices
  • Created security alert response procedures with defined timelines

🤖 AI Agent Optimization

The repository now includes:

  • Context-rich documentation for better AI understanding
  • Standardized templates providing structured input formats
  • Clear branching strategy and naming conventions
  • Automated feedback through CI/CD pipelines
  • Best practices specifically for AI-generated contributions

📋 Testing

  • ✅ Angular client builds successfully (npm run build)
  • ✅ All existing workflows validated for clarity
  • ✅ Documentation follows consistent markdown formatting
  • ✅ Templates validated with GitHub's issue/PR template schema

🔗 Reference

Implementation follows GitHub Copilot Coding Agent Best Practices

Fixes #388.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • http://168.63.129.16:80/machine/
    • Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@github-project-automation github-project-automation bot moved this to 💡 Triage in Stock Charts Jun 4, 2025
@DaveSkender DaveSkender moved this from 💡 Triage to 🏗 In progress in Stock Charts Jun 4, 2025
@DaveSkender
Copy link
Member

@copilot exclude security and code quality process aspects

Copilot AI and others added 2 commits June 4, 2025 03:34
Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
…ocumentation

Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
Copilot AI changed the title [WIP] Optimize Repository for GitHub Copilot Coding Agent Usage feat: Optimize repository for GitHub Copilot Coding Agent usage Jun 4, 2025
Copilot AI requested a review from DaveSkender June 4, 2025 03:37
Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jun 4, 2025

@copilot exclude security and code quality process aspects

I've removed the security and code quality process aspects as requested. Changes include:

  • Deleted CodeQL security scanning workflow
  • Removed CodeQL badge from README
  • Removed "Security and Code Quality" section from CONTRIBUTING.md
  • Cleaned up security-related references in documentation

The repository optimization now focuses on documentation, templates, and workflow improvements without the security/quality scanning processes. (cf05a49)

This comment was marked as resolved.

@github-project-automation github-project-automation bot moved this from 🏗 In progress to 👀 In review in Stock Charts Jun 4, 2025
… to CONTRIBUTING.md

Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
@DaveSkender
Copy link
Member

@copilot we need to add more best practices:

  • adding custom Copilot instructions to this repository
  • add missing settings.json configs for max Copilot utility
  • extend the capabilities of Copilot coding agent by using the most helpful MCP servers for this codebase
  • pre-install any missing or helpful dependencies in copilot-setup-steps.yml for Copilot environment

…uctions, enhanced VS Code settings, MCP servers, and setup automation

Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jun 4, 2025

@copilot we need to add more best practices:

  • addi...

Added comprehensive GitHub Copilot optimization with all requested best practices:

  1. Custom Copilot instructions in .github/copilot-instructions.md with full project context
  2. Enhanced VS Code settings in .vscode/settings.json with Copilot-specific configurations
  3. MCP servers configuration in .github/copilot-mcp-servers.json for Angular/.NET development
  4. Pre-installation setup in .github/copilot-setup-steps.yml with all dependencies and tools

All configurations validated and frontend build tested successfully. (55b4755)

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • http://168.63.129.16:80/machine/
    • Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@DaveSkender
Copy link
Member

@copilot you should be able to read and resolve these Codacy issues, from public page: https://app.codacy.com/gh/facioquo/stock-charts/pull-requests/389/issues

I cannot access the Codacy UR...

I don't have the ability to modify firewall allowlists - this would need to be configured by a repository administrator or in the GitHub Actions environment settings. The firewall restriction prevents me from directly accessing the Codacy issues page, but I've been working on addressing common code quality issues proactively through static analysis and manual code review.

Warning

Firewall rules blocked me from connecting to one or more addresses
Help improve Copilot by leaving feedback using the 👍 or 👎 buttons

I’ve added this to our org COPILOT_AGENT_FIREWALL_ALLOW_LIST_ADDITIONS variable

Copy link
Contributor Author

Copilot AI commented Jun 4, 2025

@copilot you should be able to read and resolve these Codacy issues, from public page: https://app.codacy.com/gh/facioquo/stock-charts/pull-requests/389/issues

...

Thanks for adding app.codacy.com to the firewall allowlist. I can now attempt to access the Codacy issues page, though the specific API endpoints aren't returning structured data. I'll continue with static code analysis to identify and fix common code quality issues that Codacy typically flags, focusing on the files in this PR branch.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • http://168.63.129.16:80/machine/
    • Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@DaveSkender
Copy link
Member

@copilot you should be able to read and resolve these Codacy issues, from public page: https://app.codacy.com/gh/facioquo/stock-charts/pull-requests/389/issues

...

Thanks for adding app.codacy.com to the firewall allowlist. I can now attempt to access the Codacy issues page, though the specific API endpoints aren't returning structured data. I'll continue with static code analysis to identify and fix common code quality issues that Codacy typically flags, focusing on the files in this PR branch.

Help improve Copilot by leaving feedback using the 👍 or 👎 buttons

You can also try reading https://github.com/facioquo/stock-charts/pull/389/checks?check_run_id=43439461816 for issues

… modernize array operations, fix semicolons

Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
…ncial.js

Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jun 4, 2025

@copilot you should be able to read and resolve these Codacy issues, from public page: https://app.codacy.com/gh/facioquo/stock-charts/pull-requests/389/issues

...
...

I accessed the GitHub checks page but it returned a web app requiring JavaScript execution. However, I performed static code analysis and identified code quality issues that Codacy typically flags. Fixed 5 trailing comma violations in chartjs-chart-financial.js. Build verified successful after changes. (09ea221)

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • api.github.com
    • Triggering command: curl -s REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@DaveSkender DaveSkender changed the title feat: Optimize repository for GitHub Copilot Coding Agent usage feat: Add GitHub Copilot Coding Agent configs Jun 4, 2025
@DaveSkender
Copy link
Member

DaveSkender commented Jun 4, 2025

@copilot you should be able to read and resolve these Codacy issues, from public page: https://app.codacy.com/gh/facioquo/stock-charts/pull-requests/389/issues

...
...

I accessed the GitHub checks page but it returned a web app requiring JavaScript execution. However, I performed static code analysis and identified code quality issues that Codacy typically flags. Fixed 5 trailing comma violations in chartjs-chart-financial.js. Build verified successful after changes. (09ea221)

Warning

Firewall rules blocked me from connecting to one or more addresses
Help improve Copilot by leaving feedback using the 👍 or 👎 buttons

Most of these issues are about linting errors in markdown files. Ensure you’re setup to adhere to markdownlint rules, and fix all issues in all markdown files, with attention on copilot instructions files

Co-authored-by: DaveSkender <8432125+DaveSkender@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jun 4, 2025

@copilot you should be able to read and resolve these Codacy issues, from public page: https://app.codacy.com/gh/facioquo/stock-charts/pull-requests/389/issues

...

Fixed all markdownlint issues in markdown files with particular attention to copilot instructions file. Added proper blank lines around headings, lists, and fenced code blocks, specified language for code blocks, and ensured trailing newlines. All files now pass markdownlint validation. (1886633)

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • http://168.63.129.16:80/machine/
    • Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@DaveSkender DaveSkender marked this pull request as ready for review June 4, 2025 07:42
@DaveSkender DaveSkender requested a review from Copilot June 4, 2025 07:42
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces comprehensive GitHub Copilot Coding Agent configurations by adding documentation, templates, workflows, and code improvements for linting, error handling, and null safety.

  • Enhanced repository documentation and contribution guides with build/test instructions and code quality standards
  • Added automated CI/CD workflows, Dependabot settings, and VS Code tasks/settings/extensions for Copilot optimization
  • Updated application code with strict equality checks, safer null handling, and structured error logging

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/CONTRIBUTING.md Added building and testing instructions for backend & frontend
docs/CODE_QUALITY.md New code quality improvements document
client/src/assets/js/chartjs-chart-financial.js Removed trailing commas to align with ESLint comma-dangle rule
client/src/app/services/utility.service.ts Added semicolons, strict equality, and safe element checks
client/src/app/services/user.service.ts Changed null check for settings from loose to strict
client/src/app/services/config.service.ts Updated fill logic and added missing semicolon
client/src/app/services/chart.service.ts Multiple strict-equality updates, guards, and improved error logging
client/src/app/services/api.service.ts Used strict equality, improved error logging
client/src/app/components/picker/pick-config.component.ts Typed errorMessage and enhanced error logging
client/package.json Added lint scripts and ESLint/markdownlint dependencies
client/eslint.config.js New flat ESLint configuration
.vscode/tasks.json VS Code tasks for building and running client/server
.vscode/settings.json VS Code and Copilot editor settings
.vscode/extensions.json Recommended VS Code extensions
.markdownlint.json MarkdownLint rules configuration
.github/dependabot.yml Dependabot configuration for NuGet, npm, and Actions
.github/copilot-setup-steps.yml Pre-session Copilot environment setup workflow
.github/copilot-mcp-servers.json Model Context Protocol servers configuration
.github/copilot-instructions.md Detailed Copilot instructions for this project
Comments suppressed due to low confidence (1)

client/src/app/services/config.service.ts:277

  • Switching from c.fill == null to c.fill === null changes behavior if c.fill is undefined. Consider using c.fill == null (loose check) or explicitly checking both null and undefined to maintain original logic.
fill: c.fill === null ? false : {

DaveSkender and others added 2 commits June 4, 2025 03:53
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
@DaveSkender DaveSkender enabled auto-merge (squash) June 4, 2025 07:54
Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com>
@DaveSkender DaveSkender merged commit e87e09e into main Jun 4, 2025
8 checks passed
@DaveSkender DaveSkender deleted the copilot/fix-388 branch June 4, 2025 09:17
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Stock Charts Jun 4, 2025
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Optimize Repository for GitHub Copilot Coding Agent Usage

3 participants