Skip to content

Add comprehensive GitHub Copilot instructions for source-map-parser development#6

Closed
Copilot wants to merge 1 commit intomainfrom
copilot/fix-5
Closed

Add comprehensive GitHub Copilot instructions for source-map-parser development#6
Copilot wants to merge 1 commit intomainfrom
copilot/fix-5

Conversation

Copy link

Copilot AI commented Aug 30, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the source-map-parser codebase.

What's included

The instructions cover the complete development workflow for this Rust workspace project:

Build & Test Process:

  • Exact commands with validated timeouts (e.g., cargo build --workspace takes 60 seconds, wasm-pack test --node takes 4.5 minutes)
  • Critical "NEVER CANCEL" warnings for long-running operations
  • Both native Rust and WASM build/test workflows

WASM Development:

  • Complete wasm-pack installation and setup process
  • Node.js WASM package build and testing
  • Troubleshooting for common network issues (binaryen download failures)

Code Quality:

  • Formatting (cargo fmt) and linting (cargo clippy) workflows
  • Acceptable vs. must-fix warning categories

Validation Scenarios:

  • Functional test examples for core source map parsing features
  • Node.js WASM integration verification
  • Stack trace parsing validation

Repository Structure:

  • Key directories and file organization
  • Core API overview for both Rust library and WASM bindings
  • Common development commands reference

Validation

All commands and examples in the instructions have been thoroughly tested and validated:

  • Build times measured and documented with appropriate timeout buffers
  • WASM functionality confirmed working with real Node.js examples
  • Alternative workflows provided for network-restricted environments
  • Functional scenarios verified to work correctly

The instructions follow the imperative tone requirement and provide exhaustive detail to ensure any developer can successfully work with this codebase from a fresh clone.

Fixes #5.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@MasonChow MasonChow closed this Aug 30, 2025
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for source-map-parser development Aug 30, 2025
Copilot AI requested a review from MasonChow August 30, 2025 06:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants