Skip to content

Contributing Guidelines

Thank you for your interest in contributing to NETRA! We welcome contributions from developers worldwide.


Development Workflow

  1. Fork & Clone: Fork the repository on GitHub and clone your fork locally.

  2. Environment Setup: Ensure you have Java 25 LTS, Gradle 9, Docker, Node.js 20+ & npm, and Python 3.9+ installed.

  3. 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
  1. Code Standards:
  2. Adhere to modern Java 25 practices (Records, Pattern Matching, Virtual Threads).
  3. Maintain strict BigDecimal financial arithmetic.
  4. Run unit and integration tests before committing:

    make test
    
  5. Evaluation Verification: Ensure all benchmark suites pass:

make smoke
make routing-eval
make cache-eval
make load
  1. Submitting Pull Requests: Push your branch and open a PR against main. Provide a clear summary of changes, rationale, and test results.

  2. Questions & Maintenance: For questions, architectural discussions, or project maintenance inquiries, contact the project maintainer at shashankchandel@gmail.com or open a GitHub Discussion.