Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

18 lines (11 loc) · 1.29 KB

Contributing to CadCAD.jl

Aqua Static Badge Jet Static Badge

Thanks for taking the time to contribute. We appreciate it very much!

Any contribution to CadCAD.jl is welcome in the following ways:

Remeber that all new code must be accompanied by unit tests.

Previewing Documentation Edits

Modifications to the documentation can be previewed by building the documentation locally, which is made possible by a script located in docs/make.jl. The Documenter package is required and can be installed by running import Pkg; Pkg.add("Documenter") in a REPL session. Then the documentation can be built and previewed in build/ first by running julia docs/make.jl from a terminal.