Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 3, 2025

Adds comprehensive Copilot coding agent instructions to help contributors understand and work effectively with this devcontainer features repository.

The new .copilot-instructions.md file provides detailed guidance covering:

Repository Context

  • Clear explanation of devcontainer features and their purpose in GitHub Codespaces
  • Complete documentation of the repository structure (/src/, /test/, workflows)
  • Overview of all current features with descriptions

Development Guidelines

  • Step-by-step process for creating new features
  • Feature implementation best practices (error handling, logging, idempotency)
  • Cross-platform compatibility requirements (Ubuntu, Debian, Mariner Linux)
  • Semantic versioning guidelines with SemVer specification for MAJOR, MINOR, and PATCH versions
  • Version management process for updating devcontainer-feature.json during changes

Testing Framework

  • Comprehensive testing patterns using devcontainer CLI
  • Test execution commands for different scenarios
  • Integration testing with _global test scenarios

CI/CD Documentation

  • Explanation of automated testing workflows (test-pr.yaml, test-all.yaml)
  • Release process and versioning guidelines
  • Path-based change detection for efficient testing

Code Quality Standards

  • Shell script best practices and common patterns
  • JSON configuration guidelines
  • Security considerations and debugging techniques

Documentation Standards

  • Clarifies that README.md and NOTES.md files are auto-generated and should never be edited manually
  • Updated Pull Request process to include mandatory version updates following semantic versioning

This documentation follows the best practices for Copilot coding agent and will help both new contributors and AI coding assistants understand the codebase structure, conventions, and development workflows specific to devcontainer features.

Fixes #78.


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

…sitory

Co-authored-by: markphip <933108+markphip@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions ✨ Set up Copilot instructions for devcontainer features repository Sep 3, 2025
Copilot AI requested a review from markphip September 3, 2025 14:22
Copilot finished work on behalf of markphip September 3, 2025 14:22
Copy link
Contributor

@markphip markphip left a comment

Choose a reason for hiding this comment

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

@copilot looks good aside from comment that we should add something about maintaining the version as part of the update process.

Also each feature has a NOTES.md with any special notes that should appear in the README.md. That file is generated and should never be edited


## Contributing Guidelines

### Pull Request Process
Copy link
Contributor

Choose a reason for hiding this comment

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

@copilot Can we add something about semantic versioning and updating the version in devcontainer-feature.json as part of making a change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added semantic versioning section with SemVer guidelines and updated the Pull Request Process to include version updates as step 3. The changes include guidance on when to increment MAJOR, MINOR, or PATCH versions and requirement to update the version field in devcontainer-feature.json. Commit be35388

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

Copilot AI commented Sep 3, 2025

@copilot looks good aside from comment that we should add something about maintaining the version as part of the update process.

Also each feature has a NOTES.md with any special notes that should ap...

Added comprehensive version management information including semantic versioning guidelines and updated the Feature Structure section to clarify that both README.md and NOTES.md files are auto-generated and should never be edited manually. Also enhanced the Pull Request Process to include version updates as a required step. Commit be35388

@markphip markphip marked this pull request as ready for review September 3, 2025 14:30
@markphip markphip merged commit 5987e5c into main Sep 3, 2025
1 check passed
@markphip markphip deleted the copilot/fix-78 branch September 3, 2025 14:30
Copilot AI changed the title ✨ Set up Copilot instructions for devcontainer features repository ✨ Set up Copilot instructions for devcontainer features repository with versioning guidelines Sep 3, 2025
Copilot AI requested a review from markphip September 3, 2025 14:30
Copilot finished work on behalf of markphip September 3, 2025 14:31
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