Contribution Guidelines

Reporting Issues:

  • Verify if the issue already exists by searching open issues in GitHub.

  • Create a new issue using the bug or enhancement template, providing:

    • Clear title and description.

    • Steps to reproduce (for bugs).

    • Environment details (OS, Node.js version, network used).

Feature Requests:

  • Use the feature request template.

  • Include a rationale, proposed design, and potential risks or trade‑offs.

Submitting Pull Requests:

  1. Fork the repository and create a feature branch:

    git checkout -b feature/short-description
  2. Implement changes with adherence to coding standards.

  3. Write or update tests for new functionality; maintain coverage ≥ 90%.

  4. Commit changes with Conventional Commits:

    feat(module): add new sliding window throttler
    fix(api): correct error handling in order controller
  5. Push branch to your fork and open a PR against main.

  6. In PR description, reference related issues (e.g., Closes #123).

Review & Feedback:

  • Maintainers will review within 2‑3 business days.

  • Address review comments and update the PR accordingly.

  • After approval and passing CI checks, the PR will be merged.

Code of Conduct:

Last updated