|
| 1 | +# Contributing to InstaReply Bot |
| 2 | + |
| 3 | +Thank you for your interest in contributing to InstaReply Bot! This document provides guidelines for contributing to this open-source Instagram DM auto-responder project. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +### Reporting Bugs |
| 8 | + |
| 9 | +1. Check [existing issues](https://github.com/nandandas2407-web/InstaReplyBot/issues) to avoid duplicates |
| 10 | +2. Open a new issue with: |
| 11 | + - Clear title describing the bug |
| 12 | + - Steps to reproduce |
| 13 | + - Expected vs actual behavior |
| 14 | + - Device model and Android version |
| 15 | + - App version |
| 16 | + |
| 17 | +### Suggesting Features |
| 18 | + |
| 19 | +1. Open an issue with the **feature request** label |
| 20 | +2. Describe the use case and how it would benefit users |
| 21 | +3. Include mockups or examples if applicable |
| 22 | + |
| 23 | +### Pull Requests |
| 24 | + |
| 25 | +1. Fork the repository |
| 26 | +2. Create a feature branch: `git checkout -b feature/amazing-feature` |
| 27 | +3. Make your changes following the code style below |
| 28 | +4. Test thoroughly on a real device |
| 29 | +5. Commit with a clear message |
| 30 | +6. Push to your fork and submit a PR |
| 31 | + |
| 32 | +## Code Style |
| 33 | + |
| 34 | +- **Language:** Kotlin |
| 35 | +- **Architecture:** MVVM with Room database |
| 36 | +- **Formatting:** Follow [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html) |
| 37 | +- **Naming:** |
| 38 | + - Classes: PascalCase |
| 39 | + - Functions/variables: camelCase |
| 40 | + - Constants: UPPER_SNAKE_CASE |
| 41 | + |
| 42 | +## Development Setup |
| 43 | + |
| 44 | +1. Clone the repo: |
| 45 | + ```bash |
| 46 | + git clone https://github.com/nandandas2407-web/InstaReplyBot.git |
| 47 | + ``` |
| 48 | +2. Open in Android Studio (latest stable) |
| 49 | +3. Sync Gradle and build |
| 50 | +4. Run on device or emulator (Android 8.0+) |
| 51 | + |
| 52 | +## Testing |
| 53 | + |
| 54 | +- Test on real devices when possible |
| 55 | +- Verify notification listener permissions work correctly |
| 56 | +- Test with multiple AI providers (free and paid) |
| 57 | +- Ensure the one-reply-per-message guarantee holds |
| 58 | + |
| 59 | +## Questions? |
| 60 | + |
| 61 | +Open an issue with the **question** label or reach out via [GitHub Discussions](https://github.com/nandandas2407-web/InstaReplyBot/discussions). |
0 commit comments