This document provides a best practice for general development setup and code distribution. Please practice on your computer before trying for code contribution.
Pre-requisites:
Install Git on your system - Git-scm.{:target=“_blank”}
Register Github Account if you dont have one already. You can register your Github acocunt here.{:target=“_blank”}
Obtain Docker on your system. You can get docker from here.{:target=“_blank”}
(Optional) Install IDE on your operating system. e.g. Visual Studio Code{:target=“_blank”} or IntelliJ{:target=“_blank”}
Step 1 - Configure Git tool if you are behind the firewall. Show Me How{:target=“_blank”}
Step 2 - Fork the following Mnemonic project to your own Github account. Project Link{:target=“_blank”}
Step 3 - Clone the forked Mnemonic project from your own Github account by running the command below. Show Me How{:target=“_blank”}
$ git clone git@github.com:[your account id]/mnemonic.git
$ git remote add upstream https://github.com/apache/mnemonic.git
$ cd mnemonic $ git config user.email “[your apache id]@ email@example.comapache.org” $ git config user.name “[your name]”
$ # --------- For CentOS --------- $ docker build -t mnedev https://github.com/apache/mnemonic.git#:docker/docker-CentOS $ # --------- For Ubuntu --------- $ docker build -t mnedev https://github.com/apache/mnemonic.git#:docker/docker-Ubuntu
$ docker run -it -v <mnemonic_project_folder>:/ws/mnemonic mnedev
Congratulation! You have successfully completed the development setup. You are now ready to edit the project code on your host while compiling and test in isolated Docker envinroment. Please make sure you have enough space for docker based compiling and testing (>30G for test running).
Please refer to Submit Changes{:target=“_blank”} page if you would like to contribute to this project!