Contributing Guidelines¶
Thank you for your interest in contributing to NETRA! We welcome contributions from developers worldwide.
Development Workflow¶
-
Fork & Clone: Fork the repository on GitHub and clone your fork locally.
-
Environment Setup: Ensure you have Java 25 LTS, Gradle 9, Docker, Node.js 20+ & npm, and Python 3.9+ installed.
-
Branching Model: Create a descriptive branch from
main:
git checkout -b feat/intelligent-failover # Feature
git checkout -b fix/cache-boundary-leak # Fix / Bug / Chore
- Code Standards:
- Adhere to modern Java 25 practices (Records, Pattern Matching, Virtual Threads).
- Maintain strict
BigDecimalfinancial arithmetic. -
Run unit and integration tests before committing:
-
Evaluation Verification: Ensure all benchmark suites pass:
-
Submitting Pull Requests: Push your branch and open a PR against
main. Provide a clear summary of changes, rationale, and test results. -
Questions & Maintenance: For questions, architectural discussions, or project maintenance inquiries, contact the project maintainer at shashankchandel@gmail.com or open a GitHub Discussion.