|
| 1 | +# Introduction |
| 2 | + |
| 3 | +**In this project, we follow the principle of "Code over Conversations" and recommend that all newcomers adhere to this approach as well.** |
| 4 | + |
| 5 | +We believe that the best discussions arise around working code, not abstract ideas. Here you don't need to ask for permission or go through quests to create tasks. Just start — and your Pull Request will become the best beginning for discussion. |
| 6 | + |
| 7 | +## Now let's break it down point by point... |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +### **Have an idea and want to implement something?** |
| 12 | + |
| 13 | +``` |
| 14 | +Your path will look like this: |
| 15 | +1. Clone the repository to your local machine |
| 16 | +2. Create and switch to your branch |
| 17 | +3. Sync and create a PR with [WIP] prefix |
| 18 | +4. In the description, write what and why you're doing it |
| 19 | +5. Make your changes |
| 20 | +6. Push to your remote branch |
| 21 | +7. Update the PR |
| 22 | +``` |
| 23 | + |
| 24 | +______________________________________________________________________ |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | +### **Have an idea you just want to share?** |
| 29 | + |
| 30 | +``` |
| 31 | +Your path will look like this: |
| 32 | +1. Go to the "Issues" tab |
| 33 | +2. Create an issue and start the discussion |
| 34 | +3. Communicate your idea with the community |
| 35 | +``` |
| 36 | + |
| 37 | +______________________________________________________________________ |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | +### **Or just want to build something manually...** |
| 42 | + |
| 43 | +``` |
| 44 | +Your path will look like this: |
| 45 | +1. Go to the "Issues" tab |
| 46 | +2. Choose a task that interests you |
| 47 | +3. Clone the repository |
| 48 | +4. Create your branch |
| 49 | +5. Switch to it |
| 50 | +6. Sync and create a PR with [WIP] prefix |
| 51 | +7. In the description, write what and why you're doing it |
| 52 | +8. Make your changes |
| 53 | +9. Push to your remote branch |
| 54 | +10. Update the PR |
| 55 | +``` |
| 56 | + |
| 57 | +______________________________________________________________________ |
| 58 | + |
| 59 | +### Review process for any code you want to merge |
| 60 | + |
| 61 | +``` |
| 62 | +- Maintainers and community will provide feedback in comments |
| 63 | +- Make changes and push to the same branch — PR will update |
| 64 | +- When everything is ready, remove [WIP] from the title |
| 65 | +- After approval and passing tests, the PR will be merged |
| 66 | +``` |
| 67 | + |
| 68 | +______________________________________________________________________ |
| 69 | + |
| 70 | +### Code requirements |
| 71 | + |
| 72 | +``` |
| 73 | +- Code follows project style // we use PEP8 |
| 74 | +- Tests added (if applicable) |
| 75 | +- Documentation updated |
| 76 | +- All tests pass |
| 77 | +- Description clearly explains the changes |
| 78 | +``` |
| 79 | + |
| 80 | +______________________________________________________________________ |
| 81 | + |
| 82 | +### Project protection |
| 83 | + |
| 84 | +``` |
| 85 | +- `main` branch is protected — only maintainers can merge |
| 86 | +- All changes go through code review and automatic checks |
| 87 | +- Branches are automatically deleted after PR merge |
| 88 | +``` |
| 89 | + |
| 90 | +______________________________________________________________________ |
| 91 | + |
| 92 | +### Communication |
| 93 | + |
| 94 | +``` |
| 95 | +All communication takes place in several places: |
| 96 | +- "Issues" tab + relevant topic |
| 97 | +- PR + relevant request |
| 98 | +- TG group @sgr-community |
| 99 | +``` |
0 commit comments