3d-printed-nas/CONTRIBUTING.md

2.2 KiB

Contributing

Thanks for your interest in improving the 3D Printed NAS project! Contributions are welcome under the CC BY-NC-SA 4.0 license.

What's Most Needed

These are the highest-impact contributions the project needs right now:

  1. STEP file exports — If you have Fusion 360 access, export the two .f3z source files as STEP and submit a PR
  2. Schematic PDF — Export the power adapter PCB schematic from the original EDA project (KiCad, EasyEDA, etc.)
  3. PCB source files — The original KiCad/EasyEDA project for the power adapter PCB
  4. Wiring diagram — A clear diagram showing PSU → PCB → ZimaBoard → SATA → fan connections
  5. Generic 3MF plate file — Re-plate the parts in PrusaSlicer or Cura for non-Bambu users
  6. Photos — Assembly-stage photos to supplement the Instructables guide

How to Contribute

Reporting Issues

  • Open a GitHub Issue for bugs, missing information, or suggestions
  • Include your printer model and slicer if reporting print issues
  • Include photos if reporting fitment or assembly problems

Submitting Changes

  1. Fork the repository
  2. Create a descriptive branch (add-step-exports, fix-caddy-tolerance, etc.)
  3. Make your changes
  4. Submit a pull request with a clear description of what you changed and why

File Format Guidelines

File Type Preferred Format Notes
3D Models (print-ready) STL + 3MF Include both for slicer compatibility
3D Models (editable) STEP preferred, .f3z accepted STEP works across FreeCAD, SolidWorks, Onshape, etc.
Schematics PDF/SVG + source project Always include the editable source alongside exports
BOMs CSV Keep columns consistent with existing BOMs
Documentation Markdown (.md)
Images JPG or PNG Compress to <2MB per image

Remixes and Modifications

If you've adapted the enclosure for a different SBC, drive configuration, or form factor:

  • Open an issue or PR describing your modification
  • Include photos of the finished build if possible
  • Note any changes to the BOM

Code of Conduct

Be respectful and constructive. This is a hobby project — keep it fun.