Here is a guideline for reporting any bugs, issues, changes, or additions.
If a private report must be made because of confidential information, please email me with the issue.
First check the issue page to see if your issue already exists. If not, create a new issue and describe the issue as thoroughly as possible. User must have a GitHub account to create a new issue.
The following is a rough outline of how to thoroughly describe an issue:
Please provide a minimal example to recreate the bug along with the error message. Additionally, state what you expected to happen instead of the error.
Explain what will be changed, motivation for doing so, and changes in use-cases.
Please specify the compiler, version, and operating system along with an attachment of the error message.
Please create a separate branch before proceeding.
Branch naming scheme is as follows: <first-name>.<last-name>/<feature>.
As an example, james.yang/fix_exgen_feval_function.
To make changes, you need to edit the following files:
-
The entire library is in this directory, i.e. all headers are stored here.
-
These files contain all unit and integration tests.
If you add or change a feature, please also add a unit test to this file. The unit tests can be compiled and executed with
./clean-build debug
cd build/debug
ctestThe test cases are also executed on Travis once you open a pull request.