grabowski/b4l-project-template
Template
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add comprehensive file naming and versioning standards

Browse Source 
- Add FILE-NAMING-AND-VERSIONING.md with complete Semantic Versioning 2.0.0 and Harvard Data Management file naming conventions
- Update README.md with file naming standards and semantic versioning workflow
- Update KICAD-PROJECT-TEMPLATE.md with comprehensive file naming examples and git workflow
- Update hardware/bom/README.md with standardized BOM file naming conventions
- Update manufacturing/gerbers/README.md with production-ready Gerber file naming
- Update mechanical/stl/README.md with 3D printing file naming including material suffixes
- Implement YYYY-MM-DD date format and hyphen-separated naming throughout
- Add versioning strategies for hardware, software, and documentation components
- Include git tagging strategy and release management guidelines
- Provide comprehensive examples for all file types and directories
This commit is contained in:
Alexander Grabowski
2025-08-04 14:46:05 +07:00
parent a0c843204d
commit 3f5b4c7e97
6 changed files with 334 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
hardware/bom/README.md
View File

@@ -63,7 +63,13 @@ U1 | STM32F401 | LQFP-64_10x10mm | 1 | STM32F401RET6 | Digi-Key | 497
- **InteractiveHtmlBom**: Creates interactive HTML BOMs
## File Naming Convention
- `ProjectName-BOM.csv` - Basic BOM
- `ProjectName-BOM-v1.0.csv` - Versioned BOM
- `ProjectName-BOM-Extended.xlsx` - Detailed BOM with pricing
- `ProjectName-BOM-Assembly.csv` - Assembly-specific BOM
Following [FILE-NAMING-AND-VERSIONING.md](../../FILE-NAMING-AND-VERSIONING.md) standards:
- `project-name_bom_v1.0.0_2024-08-04.csv` - Basic BOM
- `project-name_bom-extended_v1.0.0_2024-08-04.xlsx` - Detailed BOM with pricing
- `project-name_bom-assembly_v1.0.0_2024-08-04.csv` - Assembly-specific BOM
- `project-name_bom-production_v2.1.0_2024-08-04.csv` - Production BOM
### Versioning Strategy
- **MAJOR**: Component changes affecting compatibility
- **MINOR**: Component value changes, new optional components
- **PATCH**: Documentation updates, supplier changes