Contributing

Pull requests:

Changes to this project should be proposed as pull requests on Github at: https://github.com/futurfusion/migration-manager

Proposed changes will then go through code review there and once acked, be merged in the main branch.

Developer Certificate of Origin:

To improve tracking of contributions to this project we use the DCO 1.1 and use a “sign-off” procedure for all changes going into the branch.

The sign-off is a simple line at the end of the explanation for the commit which certifies that you wrote it or otherwise have the right to pass it on as an open-source contribution.

Developer Certificate of Origin Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 660 York Street, Suite 102, San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Developer’s Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

An example of a valid sign-off line is:

Signed-off-by: Random J Developer <random@developer.org>

Use your real name and a valid e-mail address. Sorry, no pseudonyms or anonymous contributions are allowed.

We also require each commit be individually signed-off by their author, even when part of a larger set.

Building locally

Building Migration Manager locally requires a current version of mkosi and libnbd-dev, and should work on most Linux distributions. The UI additionally requires yarn.

After cloning the repository from GitHub, simply run:

make install

This will build and install the daemon, CLI, and worker binaries, as well as the UI and worker image.

To only build the binaries, run:

make

To only build the UI, run:

make -C ui

To only build the worker image:

make -C worker

Then, simply run migration-managerd to start the daemon, and migration-manager for the CLI.

Testing

To run the test suite, run:

make test