Skip to content

Commit 90dea98

Browse files
committed
Update CONTRIBUTING.md
1 parent 93d400d commit 90dea98

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,19 @@ Thank you for contributing to Keychron's source-available hardware project! Whet
2828

2929
### Naming Convention
3030

31-
Official files follow the pattern:
31+
Recommended naming for new and updated files:
3232
```
3333
{Model}-{Variant}-{Component}-{Date}.{ext}
3434
```
35-
Examples from the repo:
35+
Many official files in this repository already follow this pattern, for example:
3636
- `Q1-Top-Case.stp`
3737
- `K8-Max-US-Aluminum-Plate-20240924.dwg`
3838
- `V2-Max-US-Full-Model-20240812.stp`
3939
- `Stabilizer-6.25u.stp`
4040

41-
For community contributions, use Title-Case with hyphens, matching the model prefix:
41+
Some existing official files use older naming styles, including underscores, lowercase prefixes, or `8k` directory casing. Those legacy names may remain in place for historical compatibility, but new contributions should not copy those exceptions.
42+
43+
For community contributions and new official uploads, use Title-Case with hyphens, matching the model prefix:
4244
- `Q1-ISO-Plate.dxf`
4345
- `K8-Max-POM-Plate.stp`
4446
- `Q5-FR4-Plate.dxf`
@@ -53,7 +55,7 @@ For community contributions, use Title-Case with hyphens, matching the model pre
5355
Before submitting:
5456
- [ ] File opens without errors in FreeCAD or Fusion 360
5557
- [ ] Dimensions are in millimeters
56-
- [ ] File is named following the convention above
58+
- [ ] New or renamed files use the recommended hyphenated Title-Case convention above
5759
- [ ] Model is watertight (for 3D-printable components)
5860
- [ ] No proprietary software lock-in (no .f3d-only submissions)
5961

0 commit comments

Comments
 (0)