CONTRIBUTING.md

Contributing to Albumentations

Thank you for your interest in contributing to Albumentations! 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:

• Environment Setup Guide - How to set up your development environment
• Coding Guidelines - Code style, best practices, and technical requirements

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. Set Up: Follow our Environment Setup Guide
3. Create a 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 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

• Join our Discord community
• Open a GitHub issue
• Ask questions in your pull request

License

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