Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 2.01 KB
Raw

Contributing to ImportMesh package

If you would like to modify ImportMesh package yourself or contribute back to the original repository, then the following instructions can help you. First you need to install Git and clone the project from its GitHub homepage to your local computer.

Prerequisites

Essential:

Recommended:

  • WolframScript for building the .paclet file from command line. On most systems it already comes bundled with Mathematica installation.

Testing code

It is considered good practice that every (public) function in this package includes its own set of unit tests. A bunch of them is collected in Tests/Tests.wl file, using the Mathematica testing framework. It is recommended that you run them periodically during development and especially before every commit. This can be done by calling script file Tests/RunTests.wls in command line (first change directory to project root directory) or by evaluating whole notebook Tests/RunTests.nb.

Integration of tests in Git hook

Unit test can be run automatically before every commit via Git client-side hooks. File pre-commit should contain call to Tests/RunTests.wls script, which exits with value 0 if all tests pass and aborts the commit otherwise. Minimal example of pre-commit file content is:

#!/bin/sh
./Tests/RunTests.wls

How to build the package

Package currently has no documentation in notebook format (.nb). To build the package source files just need to be packaged into a .paclet file.

Packaging ImportMesh

Open terminal window (command line) in ImportMesh root directory and run file Build.wls. This will leave you with a ImportMesh-X.Y.Z.paclet file in the build folder.