-
Notifications
You must be signed in to change notification settings - Fork 2
** Directory Structure and workflow
General Guide Lines I will be following. Just so you know what to expect.
My goal is at a minimum to do a chapter a week.
Work Flow:
I will read through the chapter while completing the exercises in order. I will commit changes after every major break. This will give a good preview of before and afters with the code progression.
Code will not have any personal editions. It will come straight from the books and follow along correctly. The only exception will be ERATA found. This will be committed (if possible in one shot at the end).
Documentation will be done on a chapter Basis. I will not start documentation until after I have finished the exercises and reading for a given chapter.
Documentation will have:
A Brief description of what the chapter covered. A overview of the code concepts covered.
Documentation may Have:
Any ERATA if discovered. to include description and fix if I was able to fix it. Definitions for important concepts and wording. anything else I deemed important and would want to be able to refer back to.
Directory Structure:
I will have two main Directories:
HF-Programming
HF-Python
Under these directories I will have directories based on chapters.
Chapter directories will contain code and required files for the chapter, it may contain other code written in an attempt to solve ERRATA or different solution to the problem that allows working past a dependency that does not work with python3 (tweepy for example).
Example:
HF-Programing/HFP-CH1/code.py