About

This page contains some general information about this project, and recommendations about contributing.

Contributing

If you like this package, consider contributing!

Creating an issue in the GitHub issue tracker to report a bug, open a discussion about existing functionality, or suggesting new functionality is appreciated.

If you have written code and would like it to be peer reviewed and added to the library, you can fork the repository and send a pull request (see below). Typical contributions include fixing a bug, adding a new feature or improving the documentation (either in source code or the online manual).

You are also welcome to get in touch with us in the JuliaReach gitter chat.

Below we detail some general comments about contributing to this package. The JuliaReach Developer's Documentation describes coding guidelines; take a look when in doubt about the coding style that is expected for the code that is finally merged into the library.

Branches

Each pull request (PR) should be pushed in a new branch with the name of the author followed by a descriptive name, e.g. mforets/my_feature. If the branch is associated to a previous discussion in one issue, we use the name of the issue for easier lookup, e.g. mforets/7.

Unit testing and continuous integration (CI)

This project is synchronized with Travis CI, such that each PR gets tested before merging (and the build is automatically triggered after each new commit).

For the maintainability of this project, the test suite should pass before a PR is merged. To run the unit tests locally, you should do:

$ julia --color=yes test/runtests.jl

Contributing to the documentation

This documentation is written in Markdown, and it relies on Documenter.jl to produce the HTML layout. To build the docs, run make.jl:

$ julia --color=yes docs/make.jl

Credits

These persons have contributed to SpaceExParser.jl (in alphabetic order):