| 1 | # CONTRIBUTING |
| 2 | |
| 3 | So you're looking to contribute to AiToEarn - that's awesome! We can't wait to see what you do. We have grand ambitions to build the best platform for AI-driven earning. Any help from the community counts, truly. |
| 4 | |
| 5 | We need to be nimble and ship fast, but we also want to make sure that contributors like you get as smooth an experience as possible. We've assembled this contribution guide for that purpose, aiming at getting you familiarized with the codebase & how we work with contributors, so you could quickly jump to the fun part. |
| 6 | |
| 7 | This guide is a constant work in progress. We highly appreciate your understanding if at times it lags behind the actual project, and welcome any feedback for us to improve. |
| 8 | |
| 9 | ## Before you jump in |
| 10 | |
| 11 | Looking for something to tackle? Browse our [issues](https://github.com/AiToEarn/AiToEarn/issues) and pick one to get started! |
| 12 | |
| 13 | ### Good first issue |
| 14 | |
| 15 | Issues with titles containing **【good frist】** are issues we provide for new contributors. If you want to join our team, please submit a PR linked to such an issue. |
| 16 | |
| 17 | Join us, contribute code, and let's build something awesome together! 💡✨ |
| 18 | |
| 19 | Don't forget to link an existing issue in the PR's description. |
| 20 | |
| 21 | ### Bug reports |
| 22 | |
| 23 | > [!IMPORTANT] |
| 24 | > Please make sure to include the following information when submitting a bug report: |
| 25 | |
| 26 | - A clear and descriptive title |
| 27 | - A detailed description of the bug, including any error messages |
| 28 | - Steps to reproduce the bug |
| 29 | - Expected behavior |
| 30 | - **Logs**, if available (really important for backend issues) |
| 31 | - Screenshots or videos, if applicable |
| 32 | |
| 33 | How we prioritize: |
| 34 | |
| 35 | | Issue Type | Priority | |
| 36 | | ------------------------------------------------------------ | --------------- | |
| 37 | | Bugs in core functions (cannot login, applications not working, security loopholes) | Critical | |
| 38 | | Non-critical bugs, performance boosts | Medium Priority | |
| 39 | | Minor fixes (typos, confusing but working UI) | Low Priority | |
| 40 | |
| 41 | ### Feature requests |
| 42 | |
| 43 | > [!NOTE] |
| 44 | > Please make sure to include the following information when submitting a feature request: |
| 45 | |
| 46 | - A clear and descriptive title |
| 47 | - A detailed description of the feature |
| 48 | - A use case for the feature |
| 49 | - Any other context or screenshots about the feature request |
| 50 | |
| 51 | How we prioritize: |
| 52 | |
| 53 | | Feature Type | Priority | |
| 54 | | ------------------------------------------------------------ | --------------- | |
| 55 | | High-Priority Features as being labeled by a team member | High Priority | |
| 56 | | Popular feature requests from our community | Medium Priority | |
| 57 | | Non-core features and minor enhancements | Low Priority | |
| 58 | | Valuable but not immediate | Future-Feature | |
| 59 | |
| 60 | ## Development Environment Setup |
| 61 | |
| 62 | 1. Fork the project to your own GitHub account |
| 63 | 2. Create a feature branch: |
| 64 | ```bash |
| 65 | git checkout -b feature/your-feature-name |
| 66 | ``` |
| 67 | 3. Commit your changes: |
| 68 | ```bash |
| 69 | git add . |
| 70 | git commit -m "feat: add new feature" |
| 71 | ``` |
| 72 | 4. Push to your forked repository: |
| 73 | ```bash |
| 74 | git push origin feature/your-feature-name |
| 75 | ``` |
| 76 | 5. Create a Pull Request on GitHub |
| 77 | |
| 78 | ## Submitting your PR |
| 79 | |
| 80 | ### Pull Request Process |
| 81 | |
| 82 | 1. Fork the repository |
| 83 | 2. Before you draft a PR, please create an issue to discuss the changes you want to make |
| 84 | 3. Create a new branch for your changes |
| 85 | 4. Please add tests for your changes accordingly |
| 86 | 5. Ensure your code passes the existing tests |
| 87 | 6. Please link the issue in the PR description, `fixes #<issue_number>` |
| 88 | 7. Get merged! |
| 89 | |
| 90 | ### Setup the project |
| 91 | |
| 92 | #### Backend |
| 93 | |
| 94 | For setting up the backend service, kindly refer to our detailed instructions in [project/backend/DEVELOPER_GUIDE.md](./project/backend/DEVELOPER_GUIDE.md). This document contains step-by-step guidance to help you get the backend up and running smoothly. |
| 95 | |
| 96 | #### Other things to note |
| 97 | |
| 98 | We recommend reviewing these documents carefully before proceeding with the setup. |
| 99 | |
| 100 | ## Getting Help |
| 101 | |
| 102 | If you ever get stuck or get a burning question while contributing, simply shoot your queries our way via the related GitHub issue. |
| 103 |