Stay updated

News & Insights
Lib Comparison
FAQAlbumentationsX License Guide
API Reference

Contributing to AlbumentationsX

Thank you for your interest in contributing to AlbumentationsX! This guide will help you get started with contributing to our image augmentation library.

Quick Start

For small changes (e.g., bug fixes), feel free to submit a PR directly.

For larger changes:

  1. Create an issue outlining your proposed change
  2. Join our Discord community to discuss your idea

Contribution Guides

We've organized our contribution guidelines into focused documents:

Contribution Process

  1. Find an Issue: Look for open issues or propose a new one. For newcomers, look for issues labeled "good first issue"
  2. Fork & Set Up: Fork the repository and follow our Environment Setup Guide
  3. Create a Branch: In your fork, create a new branch: git checkout -b feature/my-new-feature
  4. Make Changes: Write code following our Coding Guidelines
  5. Test: Add tests and ensure all tests pass
  6. Submit: Open a Pull Request from your fork with a clear description of your changes

Code Review Process

  1. Maintainers will review your contribution
  2. Address any feedback or questions
  3. Once approved, your code will be merged

Project Structure

  • albumentations/ - Main source code
  • tests/ - Test suite
  • docs/ - Documentation

Getting Help

Contributor License Agreement

Before we can accept your contribution, you must sign our Contributor License Agreement (CLA). This is a one-time process that ensures we can use your contributions in both versions of AlbumentationsX:

  • Open-source version (AGPL-3.0 License)
  • Commercial version (for enterprise customers)

When you open your first pull request, the CLA Assistant bot will automatically check if you've signed. To sign, simply comment on the PR:

I have read the CLA Document and I hereby sign the CLA

The whole process takes just a few seconds and helps maintain the project's sustainability through dual licensing.