"Fossies" - the Fresh Open Source Software Archive
Member "openscad-2019.05/doc/hacking.md" (26 Jan 2019, 1340 Bytes) of package /linux/privat/openscad-2019.05.src.tar.gz:
As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format).
Alternatively you can here view
the uninterpreted source code file.
A member file download can also be achieved by clicking within a package contents listing on the according byte size field.
The OpenSCAD coding style is encoded in
Coding style highlights:
- Use 2 spaces for indentation
- Use C++11 functionality where applicable. Please read Scott Meyer’s Effective Modern C++ for a good primer on modern C++ style and features: https://shop.oreilly.com/product/0636920033707.do
Code to be committed can be beautified by installing
uncrustify (https://github.com/uncrustify/uncrustify) and running
scripts/beautify.sh. This will, by default, beautify all files that are currently changed.
Alternatively, it’s possible to beautify the entire codebase by running
scripts/beautify.sh --all. This is not recommended except in special cases like: * We’re upgrading uncrustify to fix rules globally * You’re bringing an old branch to life and want to minimize conflict cause by the large coding style update
Note: Uncrustify is in heavy development and tends to introduce breaking changes from time to time. OpenSCAD has been tested against uncrustify commit a05edf605a5b1ea69ac36918de563d4acf7f31fb (Dec 24 2017).
How to add new function/module
- Add test
- Modules: Add example
- Modules: tooltips (editor.cc)
- External editor modes
- Add to RELEASE_NOTES.md