Development Setup

This guide will help you set up your development environment with the necessary tools for contributing to the project.

Prerequisites

Clone the repository:

Open your terminal and run the following command:

git clone git@github.com:AIModelsTech/Demo-SourceCodeDocumentation.git
cd Demo-SourceCodeDocumentation

Create a virtual environment:

It’s recommended to use a virtual environment to manage dependencies. Run the following commands:
```
python3 -m venv venv
source venv/bin/activate
```
Install the required packages:

Install the dependencies listed in the requirements.txt file:
```
pip install -r requirements.txt
```
Install pre-commit hooks:

This project uses pre-commit to manage git hooks. Install the hooks by running:
```
pre-commit install
```
You can manually run the pre-commit hooks on all files with:
```
pre-commit run --all-files
```

Create a new branch:

Create a new branch for your feature or bugfix:
```
git checkout -b your-feature-name
```
Make your changes:

Make your changes and commit them with a meaningful commit message:
```
git add .
git commit -m "Add your commit message here"
```
Push your changes:

Push your changes to the repository:
```
git push origin your-feature-name
```
Create a pull request:

Open a pull request on GitHub and describe your changes.

This project is licensed under the MIT License. See the LICENSE file for more details.