GitHub Copilot Project Setup Assistant
Structured project setup workflow for GitHub Copilot using checklist-based task tracking.
Description
This skill provides a systematic approach to setting up new projects with GitHub Copilot. It guides the AI through a comprehensive checklist covering project initialization, scaffolding, customization, dependency management, compilation, and documentation. The checklist format ensures no steps are missed and provides clear progress tracking.
Instructions
When setting up a new project with GitHub Copilot, follow this structured checklist approach:
1. Initial Setup
Create or verify the `.github/copilot-instructions.md` file exists in the project rootMark this step as complete with `[x]` once verifiedDocument the completion with a brief note (e.g., "✓ Created")2. Clarify Project Requirements
Gather and document core project requirements including: - Technology stack (frontend, backend, database)
- Key features and integrations
- Architecture patterns (monorepo, microservices, etc.)
- External services or APIs to integrate
Mark as `[x]` when requirements are clearAdd a summary comment with the finalized tech stack3. Scaffold the Project
Create the complete project structure: - Directory hierarchy for frontend/backend/shared code
- Configuration files (package.json, tsconfig.json, etc.)
- Environment file templates
- Initial file stubs for main components
Mark as `[x]` when scaffolding is completeDocument what was created4. Customize the Project
Implement core functionality systematically: - Backend API routes and controllers
- Database models and schemas
- Authentication and authorization
- Frontend components and pages
- State management setup
- External service integrations
Use sub-checkboxes (indented `- [ ]`) for granular trackingMark each sub-task as complete when implementedConvert main task to `[x]` when all customizations are done5. Install Required Extensions
List any VS Code extensions required for the projectMark as `[x]` when extensions are documentedNote if no specific extensions are required6. Compile the Project
Install all dependencies: - Backend dependencies
- Frontend dependencies
- Development tools
Handle any dependency conflicts or version issuesMark as `[x]` when compilation succeedsDocument any pending issues with 🔄 symbol7. Create and Run Tasks
Set up development tasks: - Backend server start command
- Frontend dev server command
- Concurrent task runners if needed
- Build and test scripts
Test that tasks run successfullyMark as `[x]` when tasks are verifiedNote any tasks that are pending fixes8. Launch the Project
Document launch prerequisites (database connections, API keys, etc.)Provide launch instructions for each serviceMark as `[x]` when project can be launched end-to-endUse HTML comments for launch notes if not yet ready9. Ensure Documentation is Complete
Create or update comprehensive documentation: - README.md with project overview
- Installation and setup instructions
- API documentation
- Usage examples and demo credentials
- Project structure explanation
- Current status and known issues
Mark as `[x]` when documentation is thoroughUse sub-checkboxes for documentation sectionsUsage Pattern
Structure your `.github/copilot-instructions.md` file with this format:
```markdown
[ ] Verify that the copilot-instructions.md file in the .github directory is created.[ ] Clarify Project Requirements[ ] Scaffold the Project[ ] Customize the Project - [ ] Sub-task 1
- [ ] Sub-task 2
[ ] Install Required Extensions[ ] Compile the Project[ ] Create and Run Task[ ] Launch the Project[ ] Ensure Documentation is Complete```
Update checkboxes to `[x]` as you complete each step. Add inline comments with ✓, ✅, or 🔄 symbols to indicate status.
Important Notes
Always work through steps sequentially - don't skip aheadMark tasks complete only when fully verifiedUse 🔄 symbol for tasks that are in progress or have pending issuesDocument blockers and dependencies clearlyKeep the checklist updated in real-time as work progressesUse HTML comments for detailed notes that don't clutter the checklistProvide demo credentials and sample data in documentation for easier testingExample
For a full-stack web application:
```markdown
[x] Clarify Project Requirements ✓ MERN stack with OAuth[x] Scaffold the Project ✓ Created monorepo structure[x] Customize the Project ✓ Completed: - ✅ REST API with Express
- ✅ MongoDB schemas
- ✅ React frontend with routing
- ✅ JWT authentication
[x] Compile the Project ✓ All dependencies installed[x] Create and Run Task ✓ Dev servers running[ ] Launch the Project <!-- Requires MongoDB connection string in .env -->
[x] Ensure Documentation is Complete ✓ README and API docs added```
This structured approach ensures consistent, thorough project setup with clear progress tracking throughout the development process.