Update CONTRIBUTING.md

This commit is contained in:
Ivan Davidov 2017-12-25 02:58:30 +02:00 committed by GitHub
parent 81f364aa6b
commit bc10aeb7a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,10 @@
All proposed improvements are welcome. Just make sure that you have tested your changes before you submit new pull request.
* Can you run the MLL OS (``./qemu.sh``) with the changes you have made after full build from clean source tree?
* Can you run the MLL OS (``./qemu.sh``) with the changes you have made after partial rebuild (./rebuild.sh)?
* Can you run shell console in Docker (``./run_docker_console.sh``) from the MLL image with the changes you have made after full build from clean source tree?
* Can you run shell console in Docker (``./run_docker_console.sh``) from the MLL image with the changes you have made after after partial rebuild (``./rebuild.sh``)?
Full test procedure:
* Generate clean MLL source tree with ``make src``. This will produce compressed archive file, e.g. ``minimal_linux_live_26-Dec-2017_src.tar.xz`` which contains all MLL sources.
* Copy or move the source archive file in empty folder and then extract the archive.
* Build MLL with ``./build_minimal_linux_live.sh``. You should be able to run MLL (``./qemu-bios.sh`` and/or ``./qemu-uefi.sh``) with the changes you have made.
* Repackage the MLL ISO image with ``./repackage.sh``. You should be able to run MLL (``./qemu-bios.sh`` and/or ``./qemu-uefi.sh``) with the changes you have made.
* Test the generated Docker functionality with ``test_docker_image.sh``. You should see message that the test has passed.
* Run shell console in Docker with ``./run_docker_console.sh``. You should be able to invoke all MLL binaries and scripts from this console.