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:
@@ -42,11 +42,27 @@ stl/
|
||||
```
|
||||
|
||||
## File Naming Convention
|
||||
Use descriptive names that include key specifications:
|
||||
- `PCB-Mount-Bracket_M3-Holes_v2.1.stl`
|
||||
- `Sensor-Housing-Top_IP65_ABS.stl`
|
||||
- `Cable-Gland_PG16_TPU-Flexible.stl`
|
||||
- `Assembly-Jig_Main-PCB_PLA.stl`
|
||||
Following [FILE-NAMING-AND-VERSIONING.md](../../FILE-NAMING-AND-VERSIONING.md) standards:
|
||||
- `project-name_pcb-mount-bracket_v2.1.0_petg.stl`
|
||||
- `project-name_sensor-housing-top_v1.0.0_abs.stl`
|
||||
- `project-name_cable-gland_v1.2.0_tpu.stl`
|
||||
- `project-name_assembly-jig_v1.0.0_pla.stl`
|
||||
|
||||
### Naming Structure
|
||||
`[project-name]_[component-description]_[version]_[material].stl`
|
||||
|
||||
### Material Suffixes
|
||||
- `_pla` - PLA filament
|
||||
- `_petg` - PETG filament
|
||||
- `_abs` - ABS filament
|
||||
- `_tpu` - TPU flexible filament
|
||||
- `_asa` - ASA filament
|
||||
- `_pc` - Polycarbonate filament
|
||||
|
||||
### Versioning Strategy
|
||||
- **MAJOR**: Dimensional changes affecting fit/function
|
||||
- **MINOR**: Feature additions, improvements
|
||||
- **PATCH**: Print setting optimizations, minor corrections
|
||||
|
||||
## Print Settings Documentation
|
||||
Include recommended print settings for each component:
|
||||
|
||||
Reference in New Issue
Block a user