Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (25 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.41 KB

Contributing

Contributions are welcome — bug fixes, improvements to the script, and documentation are all appreciated.

Reporting bugs

Please open a GitHub Issue and include:

  • Python version (python --version)
  • OpenSCAD version (openscad --version)
  • OS and shell
  • The command you ran and the full error output

Submitting changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b fix/my-fix)
  3. Make your changes
  4. Test with dummy.csv to verify STLs are generated correctly
  5. Open a pull request against master with a clear description of what changed and why

Coding style

  • Python: follow PEP 8, standard library only (no third-party dependencies)
  • Keep PROJECT_CFG as the single place for default parameters
  • Preserve the use <...> / local-module pattern — do not switch to include <...>

Scope

This project intentionally stays small and focused:

  • The Python script is a thin generator; complex features belong in OpenSCAD
  • CSV headers (Vorname, Nachname, OE) reflect the original use case; generalisation is welcome via a PR
  • The OpenSCAD template (LEGOTextBrick-v2p1.scad) is a third-party file (CC BY-SA 4.0) and should not be modified here — contribute upstream to Lyl3's project

License

By contributing you agree that your contributions will be licensed under the MIT License.