@@ -13,8 +13,8 @@ This repository contains [devcontainer features](https://containers.dev/implemen
1313Each 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
38491 . Create directory structure: ` /src/{feature-name}/ `
39502 . Write ` devcontainer-feature.json ` with proper metadata:
169180### Pull Request Process
1701811 . Create feature branch from ` main `
1711822 . 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