Skip to content

Commit be35388

Browse files
Copilotmarkphip
andcommitted
Add semantic versioning guidelines and NOTES.md documentation info
Co-authored-by: markphip <933108+markphip@users.noreply.github.com>
1 parent e309196 commit be35388

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

.copilot-instructions.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ This repository contains [devcontainer features](https://containers.dev/implemen
1313
Each feature in `/src/{feature-name}/` contains:
1414
- `devcontainer-feature.json` - Feature metadata, options, and configuration
1515
- `install.sh` - Installation script (main implementation)
16-
- `README.md` - Feature documentation
17-
- Optional: `NOTES.md` for implementation notes
16+
- `README.md` - Feature documentation (auto-generated, do not edit manually)
17+
- Optional: `NOTES.md` - Implementation notes that get included in README.md generation (auto-generated, do not edit manually)
1818

1919
### Testing Structure
2020
- `/test/{feature-name}/` - Feature-specific tests with `scenarios.json` and test scripts
@@ -34,6 +34,17 @@ Each feature in `/src/{feature-name}/` contains:
3434

3535
## Development Guidelines
3636

37+
### Semantic Versioning
38+
Features use [semantic versioning (SemVer)](https://semver.org/):
39+
- **MAJOR** version for incompatible API changes
40+
- **MINOR** version for backward-compatible functionality additions
41+
- **PATCH** version for backward-compatible bug fixes
42+
43+
When making changes to a feature:
44+
1. Update the `version` field in `devcontainer-feature.json`
45+
2. Follow SemVer guidelines based on the type of change
46+
3. Document breaking changes in the feature description or NOTES.md
47+
3748
### Creating a New Feature
3849
1. Create directory structure: `/src/{feature-name}/`
3950
2. Write `devcontainer-feature.json` with proper metadata:
@@ -169,9 +180,10 @@ fi
169180
### Pull Request Process
170181
1. Create feature branch from `main`
171182
2. Implement feature with comprehensive tests
172-
3. Ensure all CI checks pass
173-
4. Update documentation as needed
174-
5. Request review from maintainers
183+
3. Update the `version` field in `devcontainer-feature.json` following semantic versioning
184+
4. Ensure all CI checks pass
185+
5. Update documentation as needed
186+
6. Request review from maintainers
175187

176188
### Code Review Checklist
177189
- [ ] Feature follows repository conventions

0 commit comments

Comments
 (0)