update Coding Best Practices

Author: rambasnet

notebooks/CodingBestPractices.ipynb

@@ -1065,6 +1065,57 @@
     "```"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Project Structure\n",
+    "\n",
+    "- it's best practice to organize code into a well-defined project structure\n",
+    "- a well-defined project structure helps in:\n",
+    "    - better organization of code\n",
+    "    - easier navigation and understanding of the codebase\n",
+    "    - better collaboration among team members\n",
+    "    - easier testing and deployment of the code\n",
+    "- most common project structure in python uses **src layout**\n",
+    "\n",
+    "```markdown\n",
+    "project-name/\n",
+    "│\n",
+    "├── pyproject.toml\n",
+    "├── README.md\n",
+    "├── LICENSE\n",
+    "├── .gitignore\n",
+    "│\n",
+    "├── src/\n",
+    "│   └── project_name/\n",
+    "│       ├── __init__.py\n",
+    "│       ├── cli.py\n",
+    "│       ├── core.py\n",
+    "│       └── utils/\n",
+    "│           ├── __init__.py\n",
+    "│           └── file_helpers.py\n",
+    "│\n",
+    "├── tests/\n",
+    "│   ├── test_core.py\n",
+    "│   └── utils/\n",
+    "│       └── test_file_helpers.py\n",
+    "│\n",
+    "├── docs/\n",
+    "│   └── index.md\n",
+    "|   |__ installation.md\n",
+    "|   |__ usage.md\n",
+    "│\n",
+    "└── scripts/\n",
+    "    └── dev_setup.sh\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},