Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (76 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

102 lines (76 loc) · 2.52 KB
Raw

Contributing to Random

Thank you for your interest in contributing to the Random app! This document provides guidelines and information for contributors.

🚀 Getting Started

Prerequisites

  • Android Studio Hedgehog or later
  • Android SDK API 28+
  • Kotlin 1.9+
  • JDK 11+

Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/Random.git
  3. Open the project in Android Studio
  4. Sync Gradle files and build the project

🛠 Development Guidelines

Code Style

  • Follow Kotlin coding conventions
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused

Architecture

  • Follow MVVM pattern with Repository pattern
  • Use Jetpack Compose for UI
  • Implement proper separation of concerns
  • Use dependency injection where appropriate

Testing

  • Write unit tests for business logic
  • Test UI components with Compose testing
  • Ensure all new features have test coverage

📝 Pull Request Process

  1. Create a feature branch from main
  2. Make your changes following the guidelines above
  3. Test thoroughly on different Android versions
  4. Update documentation if needed
  5. Submit a PR with a clear description

PR Template

## Description
Brief description of changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Code refactoring

## Testing
- [ ] Unit tests pass
- [ ] UI tests pass
- [ ] Tested on different devices

## Screenshots (if applicable)
Add screenshots for UI changes

🐛 Bug Reports

When reporting bugs, please include:

  • Device model and Android version
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots or screen recordings
  • Logs (if applicable)

💡 Feature Requests

For feature requests:

  • Describe the use case
  • Explain why it's needed
  • Provide examples if possible
  • Consider implementation complexity

📚 Resources

🤝 Community

📄 License

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

Thank you for contributing to Random! 🎲✨