HACKING: Re-add

Signed-off-by: John Andersen <[email protected]>

Author: John Andersen

HACKING.md

@@ -0,0 +1,63 @@
+# Hacking on DFFML
+
+Install in development mode via pip.
+
+```console
+git clone https://github.com/intel/dffml
+cd dffml
+pip install --user -e .
+```
+
+If you are working on Git features or Tensorflow models, `cd` into those
+directories and do the same.
+
+```console
+cd model/tensorflow
+pip install --user -e .
+cd -
+cd feature/git
+pip install --user -e .
+```
+
+# Git
+
+Be sure to checkout a new branch to do your work on.
+
+```console
+git checkout origin/master
+git pull
+git checkout -b my_new_thing origin/master
+```
+
+You'll need to fork the repo on GitHub too. Then add that as a remote.
+
+```console
+# $USER in this case would be your github username
+git remote add $USER [email protected]:$USER/dffml
+```
+
+Once you've commited a change on that branch you can push it to your fork.
+
+```console
+git push -u $USER my_new_thing
+```
+
+Then you can keep commiting on this branch and just use `git push` to send your
+new commits to GitHub.
+
+# Testing
+
+```console
+python3.7 setup.py test
+```
+
+# Check the Report for Unit Test Coverage
+
+These commands will generate a folder `htmlcov`, you can check the report by
+opening the `index.html` in a web browser.
+
+```console
+coverage run setup.py test
+coverage report
+coverage html
+```