Skip to content

Contributing

Thank you for your interest in contributing to the de.iterate SDK!

Development Setup

  1. Clone the repository:
bash
git clone https://bitbucket.org/deiterateapp/sdk-typescript.git
cd sdk-typescript
  1. Install dependencies:
bash
bun install
  1. Build the SDK:
bash
bun run build
  1. Run tests:
bash
bun test

Code Style

  • Use TypeScript for all source files
  • Follow the existing code style
  • Add JSDoc comments for public APIs
  • Write tests for new functionality

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Commit your changes: git commit -am 'Add new feature'
  4. Push to the branch: git push origin feature/my-feature
  5. Open a Pull Request

Reporting Issues

Please use BitBucket Issues to report bugs or request features.

When reporting bugs, include:

  • SDK version
  • Node.js/Bun/Deno version
  • Minimal reproduction code
  • Expected vs actual behavior

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Released under the MIT License.