Add comprehensive file naming and versioning standards
- 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:
@@ -81,7 +81,18 @@ Create a ZIP file containing:
|
||||
- BOM (from `/hardware/bom/`)
|
||||
|
||||
## File Naming Convention
|
||||
Use consistent naming that matches your project:
|
||||
- `ProjectName-LayerName.gbr`
|
||||
- `ProjectName-v1.0-Gerbers.zip`
|
||||
- Include version numbers for tracking
|
||||
Following [FILE-NAMING-AND-VERSIONING.md](../../FILE-NAMING-AND-VERSIONING.md) standards:
|
||||
- `project-name_gerbers_v1.0.0_2024-08-04.zip` - Complete Gerber package
|
||||
- `project-name_gerber-job_v1.0.0_2024-08-04.gbrjob` - Gerber job file
|
||||
- `project-name_fabrication-notes_v1.0.0_2024-08-04.txt` - Manufacturing notes
|
||||
|
||||
### Individual Layer Files
|
||||
- `project-name-f-cu_v1.0.0.gbr` - Front copper
|
||||
- `project-name-b-cu_v1.0.0.gbr` - Back copper
|
||||
- `project-name-f-silks_v1.0.0.gbr` - Front silkscreen
|
||||
- `project-name-edge-cuts_v1.0.0.gbr` - Board outline
|
||||
|
||||
### Versioning Strategy
|
||||
- **MAJOR**: PCB layout changes, layer stack changes
|
||||
- **MINOR**: Component placement changes, routing updates
|
||||
- **PATCH**: Silkscreen updates, minor corrections
|
||||
|
||||
Reference in New Issue
Block a user