Thank you for your interest in contributing to KDownloader! This document provides guidelines for contributing to the project.
- Fork the repository
- Clone your fork locally
- Create a branch for your changes
- JDK 8 or higher
- Android SDK with API 34
- Xcode (for iOS development on macOS)
# Build the library
./gradlew build
# Build example app
./gradlew :example:androidApp:build- Follow Kotlin coding conventions
- Use meaningful variable and function names
- Keep functions focused and concise
- Shared code goes in
commonMain - Platform-specific implementations go in
androidMainoriosMain - Use
expect/actualdeclarations for platform-specific APIs - Avoid platform-specific dependencies in common code
- Use clear, descriptive commit messages
- Start with a verb (Add, Fix, Update, Remove)
- Keep the first line under 72 characters
- Update your branch with the latest
main - Ensure the build passes:
./gradlew build - Open a pull request with a clear description
- Link any related issues
When reporting issues, please include:
- Library version
- Platform (Android/iOS) and OS version
- Steps to reproduce
- Expected vs actual behavior
- Relevant code snippets or logs
By contributing, you agree that your contributions will be licensed under the Apache License 2.0.