| # Contributing to Miruro-API | |
| Thanks for your interest in contributing to **Miruro-API**! | |
| This project is independently maintained, and I truly appreciate any help, feedback, or improvements. | |
| Even small contributions make a difference. | |
| --- | |
| ## Ways You Can Contribute | |
| You can contribute by: | |
| - Reporting bugs | |
| - Suggesting new features | |
| - Improving documentation | |
| - Submitting pull requests | |
| - Helping improve performance or code quality | |
| --- | |
| ## Reporting Bugs | |
| If you find a bug, please open an issue and include: | |
| - A clear and descriptive title | |
| - A detailed explanation of the issue | |
| - Steps to reproduce it | |
| - Expected vs actual behavior | |
| - Relevant logs or screenshots (if applicable) | |
| The more detail you provide, the easier it is for me to investigate. | |
| --- | |
| ## Suggesting Features | |
| Have an idea? I’d love to hear it. | |
| Before opening a feature request: | |
| 1. Check existing issues to avoid duplicates | |
| 2. Clearly explain what you'd like to see | |
| 3. Describe why it would be useful | |
| 4. Provide examples if possible | |
| Not all suggestions may be implemented, but I’ll review them. | |
| --- | |
| ## Pull Requests | |
| If you'd like to submit changes: | |
| 1. Fork the repository | |
| 2. Create a new branch (`feature/name` or `fix/name`) | |
| 3. Make your changes | |
| 4. Keep commits clean and descriptive | |
| 5. Ensure your code follows the existing style | |
| 6. Submit a pull request with a clear explanation | |
| I may request changes before merging to maintain consistency and quality. | |
| --- | |
| ## Code Style | |
| - Follow the existing structure and naming conventions | |
| - Write clean, readable code | |
| - Add comments where necessary | |
| - Avoid unnecessary dependencies | |
| - Keep changes focused and minimal | |
| --- | |
| ## Documentation | |
| Good documentation is important. | |
| If you add new features or change behavior, update the README or relevant docs accordingly. | |
| --- | |
| ## Important Notice | |
| This project involves reverse-engineered API logic. | |
| Please ensure contributions: | |
| - Do not violate third-party terms of service | |
| - Do not introduce malicious code | |
| - Remain ethical and educational | |
| If you're unsure about something, open an issue first. | |
| --- | |
| ## Final Note | |
| This is a solo project maintained in my spare time. | |
| Responses may not be instant, but I do review all contributions. | |
| Thanks for helping improve Miruro-API 🚀 | |