Contributing and Security

Contributing and Security

Contributing

Start with the repository files:

• CONTRIBUTING.md
• CODE_OF_CONDUCT.md
• SECURITY.md

Good contributions are focused and easy to review.

Contribution type	Useful context
Bug fix	Reproduction steps, expected behavior, screenshots/logs
Test	Targeted scenario and why it matters
Import/export	Sample file shape and compatibility goal
Printer workflow	Firmware type, transport, and safety considerations
Documentation	User task being clarified

Examples:

• Bug fixes with clear reproduction notes
• Tests for slicer or geometry edge cases
• Importer and exporter improvements
• Viewport interaction fixes
• Printer workflow improvements
• Documentation that helps new users run, develop, or self-host the app

Before opening a pull request, run the relevant checks:

npm run typecheck
npm run lint
npm run test:run
npm run build

Security

Do not report security issues in public GitHub issues. Follow SECURITY.md.

Never commit:

• Printer credentials
• Wi-Fi credentials
• Updater keys
• GitHub tokens
• Local G-code test files
• Generated caches
• Private project files

License

Cindr3D is released under the MIT License. See LICENSE.

The bundled Roboto font is licensed separately by Google under Apache-2.0. See THIRD_PARTY_NOTICES.md.