# Contributing to SentinelReview AI We welcome contributions to improve the SentinelReview AI platform! Please read through these guidelines before submitting updates. ## Development Setup 1. **Clone the Repository**: ```bash git clone https://github.com/amad-mateen/SentinelReview-AI.git cd SentinelReview-AI ``` 2. **Virtual Environment**: ```bash python -m venv .venv source .venv/bin/activate # Windows: .venv\Scripts\activate ``` 3. **Install Dependencies**: ```bash pip install -r requirements.txt ``` 4. **Add Pre-Trained Weights**: Ensure `DistilBert_resnet.pth` is placed in the `./models` directory. --- ## Coding Standard Guidelines * **Code Style**: Adhere to PEP-8 guidelines for Python code. * **Typing Hints**: Add static type annotations for all new modules and helper functions. * **Exception Boundaries**: Catch specific error instances instead of blank `except Exception:` scopes, logging alerts with tracebacks. * **UI Themes**: Keep HTML layouts responsive and maintain the dark dashboard style. --- ## Workflow Process 1. Create a descriptive feature branch: ```bash git checkout -b feature/auth-metrics ``` 2. Write unit tests for new custom preprocessors. 3. Verify that the local server launches and processes `/analyze` routes successfully: ```bash python app.py ``` 4. Push branches and submit Pull Requests to the main branch.