|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +First of all, thank you for considering contributing to the project! Open source |
| 4 | +projects like this one grow and thrive thanks to the contributions from people |
| 5 | +like you. Whether you're fixing bugs, adding new features, improving the |
| 6 | +documentation, or even reporting issues, every contribution is valuable and |
| 7 | +appreciated. |
| 8 | + |
| 9 | +This document provides some guidelines to help ensure that your contributions |
| 10 | +are as effective as possible. Please take a moment to read through these |
| 11 | +guidelines before submitting your contribution. |
| 12 | + |
| 13 | +Remember, everyone contributing to this project is expected to follow our code |
| 14 | +of conduct. This helps ensure a positive and inclusive environment for all |
| 15 | +contributors. |
| 16 | + |
| 17 | +Thank you again for your contributions, and we look forward to seeing what you |
| 18 | +will bring to the project! |
| 19 | + |
| 20 | +## Creating Good Tickets |
| 21 | + |
| 22 | +> [!TIP] |
| 23 | +> Before creating a new issue, it's a good practice to search for open tickets |
| 24 | +> and pull requests to avoid duplicates. |
| 25 | +
|
| 26 | +### Bug Reports |
| 27 | + |
| 28 | +When reporting a bug, please include the following information: |
| 29 | + |
| 30 | +1. **Title**: A brief, descriptive title for the bug. |
| 31 | +2. **Version**: The version of the package you are using. |
| 32 | +3. **Android Version**: The version of iOS you are using. |
| 33 | +4. **Android Toolkit Version**: The version of Android Toolkit (Android Studio) |
| 34 | + you are using. |
| 35 | +5. **Steps to Reproduce**: Detailed steps on how to reproduce the bug. |
| 36 | +6. **Expected Result**: What you expected to happen. |
| 37 | +7. **Actual Result**: What actually happened. Include logs, screenshots, or any |
| 38 | + other relevant information. |
| 39 | + |
| 40 | +### Feature Requests |
| 41 | + |
| 42 | +When requesting a new feature, please include the following information: |
| 43 | + |
| 44 | +1. **Title**: A brief, descriptive title for the feature request. |
| 45 | +2. **Request Statement**: Describe the problem that you believe the project |
| 46 | + could solve but currently doesn't. |
| 47 | +3. **Solution Brainstorm**: Share your ideas on how the problem could be solved. |
| 48 | + If you don't have a specific solution in mind, that's okay too! |
| 49 | + |
| 50 | +> [!TIP] |
| 51 | +> Remember, the more information you provide, the easier it is for us to |
| 52 | +> understand and address the issue. Thank you for your contributions! |
| 53 | +> Please refrain from commenting on old, closed tickets. If an old issue seems |
| 54 | +> related but doesn't fully address your problem, it's best to open a new ticket |
| 55 | +> and reference the old one instead. |
| 56 | +
|
| 57 | +## Development |
| 58 | + |
| 59 | +This project contains a private code, not available for public reading or |
| 60 | +editing. Please unterstand this measurement to prevent security risks. |
| 61 | +Developing new features or fixing bugs can be done in both private and public |
| 62 | +parts of this project. You are welcome to participate in public part! |
| 63 | + |
| 64 | +### Setup |
| 65 | + |
| 66 | +Please use the latest Android Studio Version. Use the provided example project |
| 67 | +to test or bug report any existing or new features. |
| 68 | + |
| 69 | +## Submitting changes |
| 70 | + |
| 71 | +Before submitting your changes as a pull request, please make sure to format |
| 72 | +and analyze your code. |
0 commit comments