Skip to content

Add comprehensive GitHub Copilot instructions for WealthsimpleDownloader#248

Merged
Nef10 merged 5 commits intomainfrom
copilot/fix-247
Aug 31, 2025
Merged

Add comprehensive GitHub Copilot instructions for WealthsimpleDownloader#248
Nef10 merged 5 commits intomainfrom
copilot/fix-247

Conversation

Copy link
Contributor

Copilot AI commented Aug 25, 2025

This PR creates comprehensive GitHub Copilot instructions that tell coding agents exactly how to work effectively in the WealthsimpleDownloader codebase. The instructions provide validated commands, exact timeouts, and complete workflows for building, testing, and validating changes.

Key Features

Validated Commands with Exact Timeouts:

  • swift build - 5 seconds actual runtime, 60+ second timeout recommended
  • swift test --enable-code-coverage -Xswiftc -warnings-as-errors - 4 seconds actual, 30+ second timeout
  • SwiftLint installation and execution via curl download (GitHub Actions compatible)

Complete Validation Workflow:

  • Build → Test with coverage and strict warnings → Lint with strict rules → Manual library validation
  • Includes "NEVER CANCEL" warnings with specific time expectations for all long-running operations
  • Manual library validation pattern that ensures API compatibility after changes

Swift Package Manager Focus:

  • Pure Swift library (no runnable applications)
  • Documents the Swift 6.1.2+ requirement and multi-platform support
  • Explains the library-only nature and API-focused validation approach

CI Integration:

  • Commands match exactly what runs in .github/workflows/ci.yml
  • SwiftLint 0.59.1 installation mirrors the CI pipeline
  • Coverage enforcement and strict warning compilation included

Comprehensive Reference:

  • Repository structure with actual directory listings
  • Key Package.swift content for quick reference
  • Project details including platforms, dependencies, and documentation links

The instructions start with a firm directive to "always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information" to ensure agents follow the validated workflow.

All commands have been exhaustively tested from scratch to ensure they work exactly as documented, including timeout validation and complete end-to-end scenarios.

Fixes #247.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits August 25, 2025 05:39
Co-authored-by: Nef10 <4551135+Nef10@users.noreply.github.com>
Co-authored-by: Nef10 <4551135+Nef10@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for WealthsimpleDownloader Aug 25, 2025
Copilot AI requested a review from Nef10 August 25, 2025 05:45
@Nef10 Nef10 marked this pull request as ready for review August 31, 2025 04:39
@github-actions
Copy link

Minimum coverage required: 0%


Coverage after merging copilot/fix-247 into main

1.88%

Coverage Report
FileStmtsFuncsLinesUncovered Lines
Sources/Wealthsimple
   Token.swift0%0%0%100–104, 111–124, 132–154, 156–167, 169–192, 194–198, 200–206, 208–210, 212–220, 222–226, 47–52, 54–66, 68–79, 81–99
   TransactionError.swift0%0%0%29–46
   WealthsimpleAccount.swift0%0%0%100–114, 116–139, 141–160, 82–97, 99
   WealthsimpleAsset.swift0%0%0%52–68
   WealthsimpleDownloader.swift0%0%0%102–115, 122–135, 137–149, 48–51, 55–78, 82–95
   WealthsimplePosition.swift0%0%0%100–117, 119–142, 144–163, 53–57, 66–92, 94–99
   WealthsimpleTransaction.swift0%0%0%129–133, 152–196, 198–223, 225–248, 250–269
Sources/Wealthsimple/Extensions
   String+CamelCase.swift100%100%100%

@Nef10 Nef10 merged commit 12dee1a into main Aug 31, 2025
4 checks passed
@Nef10 Nef10 deleted the copilot/fix-247 branch August 31, 2025 16:55
@Nef10 Nef10 added the maintenance Internal, non-code related changes label Sep 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Internal, non-code related changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants