SentinelReview-AI / CONTRIBUTING.md
amadmateen's picture
Refactor: Production-grade modular layout, NLTK permissions fix, and editorial audit dashboard overhaul
405a3f0
|
Raw History Blame Contribute Delete
1.42 kB

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:

    git clone https://github.com/amad-mateen/SentinelReview-AI.git
    cd SentinelReview-AI
    
  2. Virtual Environment:

    python -m venv .venv
    source .venv/bin/activate  # Windows: .venv\Scripts\activate
    
  3. Install Dependencies:

    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:
    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:
    python app.py
    
  4. Push branches and submit Pull Requests to the main branch.