Spaces:
Sleeping
Sleeping
Refactor: Production-grade modular layout, NLTK permissions fix, and editorial audit dashboard overhaul
405a3f0 |
Download CONTRIBUTING.md from amadmateen/SentinelReview-AI: direct link, hf CLI and curl.
- Browser
- Download file 1.42 kB
-
https://huggingface.co/spaces/amadmateen/SentinelReview-AI/resolve/main/CONTRIBUTING.md
- Command line
-
hf download hf://spaces/amadmateen/SentinelReview-AI/CONTRIBUTING.md
-
curl -L -o CONTRIBUTING.md https://huggingface.co/spaces/amadmateen/SentinelReview-AI/resolve/main/CONTRIBUTING.md
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
Clone the Repository:
git clone https://github.com/amad-mateen/SentinelReview-AI.git cd SentinelReview-AIVirtual Environment:
python -m venv .venv source .venv/bin/activate # Windows: .venv\Scripts\activateInstall Dependencies:
pip install -r requirements.txtAdd Pre-Trained Weights: Ensure
DistilBert_resnet.pthis placed in the./modelsdirectory.
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
- Create a descriptive feature branch:
git checkout -b feature/auth-metrics - Write unit tests for new custom preprocessors.
- Verify that the local server launches and processes
/analyzeroutes successfully:python app.py - Push branches and submit Pull Requests to the main branch.