Reference

Contributing

Sendexa's SDKs and documentation are open source. We welcome bug reports, feature requests, and pull requests from the community.

How to Contribute
  1. Fork the repository on GitHub and create a branch from main.
    Bash
    git clone https://github.com/sendexa/<repo>.git
    cd <repo>
    git checkout -b feat/my-improvement
  2. Install dependencies and run the existing test suite to confirm everything passes before making changes.
  3. Make your changes. Keep commits small and focused. Write or update tests for any behaviour you add or change.
  4. Run the full test suite and ensure it passes with no regressions.
  5. Open a pull request against main. Fill in the PR template — describe the problem, the solution, and how to test it.
Pull Request Guidelines
One concern per PR — separate bug fixes from features.
Follow the existing code style (lint and format rules are enforced in CI).
Write tests. PRs that add untested behaviour are unlikely to be merged.
Update relevant documentation if your change affects public APIs or behaviour.
Keep the PR description clear — explain the "why" not just the "what".
Be responsive to review feedback. Stale PRs may be closed after 30 days.
Reporting Bugs

Open an issue on the relevant GitHub repository. Include the following in your report:

  • SDK version and runtime / language version.
  • A minimal code snippet that reproduces the issue.
  • The expected behaviour and the actual behaviour.
  • Any relevant error messages or stack traces.

For security vulnerabilities, do not open a public issue — see the Security page for responsible disclosure instructions.