This section aims to regroup useful information for contributing to FreeDiscovery.
Please feel free to open an issue in the GitHub issue tracker at https://github.com/FreeDiscovery/FreeDiscovery for any problem that you may encounter.
Running the test suite (cf. below) may also help in diagnosing the source of the problem.
- Download and install the developpement verision of FreeDiscovery,
this will create a virtualenv called
fd-env which you can activate with
source activate fd-env then start freediscovery with
freediscovery run.Note: if you already have the
fd-env environement, you may need to delete it first with
conda env remove -n fd-env.
This section describes the workflow for creating Pull Requests (PR). For more complex contributions, it may also be useful to create an associated issue.
- Fork the FreeDiscovery repository
- Clone this fork on your computer and install it
- Make the appropriate changes
- Make sure that the tests suite (cf. below) does not produce errors
- Commit and push the changes to GitHub
- Create a Pull Request from your branch to the
- If any of the continuous integration services (Travis CI, Appveyor CI, Circle CI) produce an error, review the corresponding output and fix the code if appropriate.
- After the PR is merged, this branch can be safely deleted from your fork (and a new one may be created for subsequent contributions).
A two level test suite is implemented in FreeDiscovery, that validates both the algorithms and the REST API,
The tests are located under
freediscovery/tests/ and can be run with,
1. Sphinx documentation
The html documentation can be built from sources with,
which requires to install dependencies in
build_tools/requirements_extra_pip.txt. This would also run and include examples using
make latexpdf generates documentation in .pdf format (requires
2. REST API documentation
The rest API documentation can be generated with,