Skip to content

Add instructions for creating YAML based image definition files for dev box #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mikeparker104
Copy link

This request add instructions to aid in generating YAML based image definition files for use with Microsoft Dev Box Team Customizations.

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run node update-readme.js and verified that README.md is up to date.

Description

Comprehensive authoring guidelines for generating YAML based image definition files that can be used with Microsoft Dev Box Team Customizations. The instructions focus on helping to setup and use available Dev Box tooling, applying recommendations from official documentation, and highlighting common issues and troubleshooting suggestions.


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • Other (please specify):

Additional Notes

None


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

@mikeparker104 mikeparker104 marked this pull request as ready for review August 6, 2025 08:08
@Copilot Copilot AI review requested due to automatic review settings August 6, 2025 08:08
Copilot

This comment was marked as outdated.

@mikeparker104 mikeparker104 requested a review from Copilot August 6, 2025 11:57
Copy link
Contributor

@Copilot 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 adds comprehensive instructions for creating YAML-based image definition files for Microsoft Dev Box Team Customizations. The instructions provide guidance on using Dev Box tooling, applying best practices from official documentation, and troubleshooting common issues.

Key changes:

  • Adds detailed authoring guidelines for Dev Box image definition files
  • Includes critical workflow steps for checking tool availability and customization tasks
  • Provides security guidance for handling secrets with Azure Key Vault
  • Documents troubleshooting approaches and common issues

Reviewed Changes

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

File Description
instructions/devbox-image-definition.instructions.md New comprehensive instruction file covering Dev Box image definition authoring, tool usage, security practices, and troubleshooting
README.md Adds table entry for the new Dev Box image definitions instruction file

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.

1 participant