Getting the source code

console git clone https://github.com/analizo/analizo.git

Installing Dependencies

Note that this option of installing dependencies is recommended just to create a development environment to hack analizo.

Run this command:

console ./development-setup.sh

If you are using Debian, the script will do everything you need, but it requires Debian 11 or superior.

If you are using another system, you will have to install some dependencies first. Check the "Installing dependencies on non-Debian systems" below.

Installing dependencies on non-Debian systems

1) Install Doxyparse build dependencies: flex, bison, libqt4-dev, gcc, gcc-c++, python, and git (your operating system probably already has packages for these)

2) Install Doxyparse (see Doxyparse README)

Running the test suite

Just run dzil test in the root of the sources:

console dzil test

To run a single unit test use prove:

console prove t/Analizo/Metrics.t

Features can also be executed with pherkin as:

console pherkin t/features/metrics-batch.feature

See "Installing Dependencies" above for a guide to install all the software that's needed to run Analizo tests.

Running the test suite on FreeBSD

It uses Vagrant FreeBSD VM running on top of libvirt. Steps:

console vagrant up --provider=libvirt vagrant ssh sudo pkg install p5-App-cpanminus p5-Dist-Zilla p5-local-lib p5-ZMQ-FFI p5-Import-Into flex bison cmake python git cd analizo dzil -I ~/perl5/lib/perl5 authordeps --missing | cpanm --notest dzil -I ~/perl5/lib/perl5 listdeps --missing | cpanm --notest dzil -I ~/perl5/lib/perl5 test

To keep Analizo's source sync with VM:

vagrant rsync-auto

To update Vagrant image:

vagrant box update --provider=libvirt

Stop VM:

vagrant halt

Remove VM:

vagrant destroy


console dzil build

Style and Good practices

Always write automated tests for your code:

Refactoring code to make it simpler, easier to change or extend is always a good thing. Just make sure that the entire test suite still passes after you do any refactoring.

Use 2 indentation of 2 spaces.

Please always put the opening curly brace of a block in the same line of the corresponding instruction (e.g. if, for etc).


if (...) \{ ... \}


if (...) \{ ... \}

Always "use strict" in the top of new modules.

Don't bother changing the AUTHORS file. It's automatically generated as part of the release process. See the dist.ini for more information.

Sending patches

Send the patches to the Analizo mailing list: analizo@googlegroups.com (see subscription instructions at community page) or to joenio@joenio.me. Or create a pull request on github.

To create a patch:

console git clone https://github.com/analizo/analizo.git cd analizo edit file git commit file git format-patch origin

This will generate patch files named like 0001-message-you-typed-for-the-commit.patch.

If you want to make several changes, please consider making one commit (and therefore one patch) for each different logical change you want to make. In this case, after running git format-patch you'll have a series of patch files named like 0001-..., 0002-..., just send them all.

You are encouraged to learn how to use git since it's a powerful version control system and it can make it easy for you to keep in sync with Analizo development.

Please write good commits messages. Read the following two links, and use common sense:

Patches with multiple authors should list the authors in the end of commit message, using a Signed-off-by tag, one author per line. Example:

Signed-off-by: John Doe <johndoe@example.org> Signed-off-by: Random Hacker <rhacker@example.org>

See commit 005c3bff4e0809eae0340e7629678186d1621930 for an example.