|
1 | | -# 📚 Contributing Guide |
| 1 | +# 📚 Руководство по вкладу (Contributing Guide) |
2 | 2 |
|
3 | | -Спасибо, что заинтересовались вкладом в этот проект! Ниже описаны основные правила и рекомендации. |
| 3 | +Спасибо, что решили внести вклад в этот проект! Мы ценим каждую помощь, будь то исправление опечаток, улучшение документации, добавление новой функциональности или сообщение об ошибке. |
| 4 | + |
| 5 | +--- |
4 | 6 |
|
5 | 7 | ## 🛠️ Как внести вклад |
6 | 8 |
|
7 | | -1. **Fork** репозиторий. |
8 | | -2. **Создайте ветку** для вашей фичи или исправления: |
9 | | - `git checkout -b feature/имя-фичи` |
10 | | - или |
11 | | - `git checkout -b fix/имя-исправления` |
12 | | -3. **Сделайте коммиты**: |
13 | | - Пишите понятные сообщения к коммитам. |
14 | | -4. **Сделайте push** в вашу ветку: |
15 | | - `git push origin feature/имя-фичи` |
16 | | -5. **Создайте Pull Request** (PR) на GitHub. |
| 9 | +1. Сделайте **Fork** репозитория. |
| 10 | +2. Создайте новую ветку: |
| 11 | + `git checkout -b feature/ваша-фича` или `git checkout -b fix/ваше-исправление` |
| 12 | +3. Внесите изменения. |
| 13 | +4. Проверьте, что все тесты проходят: |
| 14 | + `pytest`, `npm test`, или другая команда (уточняется в README). |
| 15 | +5. Сделайте коммит (см. формат ниже). |
| 16 | +6. Отправьте ветку: |
| 17 | + `git push origin feature/ваша-фича` |
| 18 | +7. Создайте **Pull Request** на GitHub и опишите: |
| 19 | + - Что изменено |
| 20 | + - Почему это важно |
| 21 | + - Ссылки на связанные issue, если есть |
| 22 | + |
| 23 | +--- |
17 | 24 |
|
18 | | -## 📋 Требования к Pull Request |
| 25 | +## ✅ Требования к Pull Request |
19 | 26 |
|
20 | | -* Следуйте стилю кода проекта. |
21 | | -* Убедитесь, что код компилируется и проходит все тесты. |
22 | | -* Добавьте тесты, если это необходимо. |
23 | | -* Опишите, что именно вы изменили и зачем. |
| 27 | +- Код должен быть чистым, читаемым и отформатированным согласно стандартам проекта. |
| 28 | +- Все существующие и новые тесты должны проходить. |
| 29 | +- Название и описание PR должны быть понятными. |
| 30 | +- Если меняется интерфейс (UI), добавьте скриншоты. |
24 | 31 |
|
25 | | -## 💡 Предложения и баги |
| 32 | +--- |
26 | 33 |
|
27 | | -* Сообщайте об ошибках через [Issues](https://github.com/ваш-проект/issues). |
28 | | -* Перед добавлением новой фичи откройте issue для обсуждения. |
| 34 | +## ✍️ Формат сообщений коммитов |
29 | 35 |
|
30 | | -## 📄 Лицензия |
| 36 | +Используем [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/): |
| 37 | + |
| 38 | +``` |
| 39 | +тип(область): краткое описание |
| 40 | +
|
| 41 | +[дополнительное описание] |
| 42 | +[ссылки на issue, задачи и т.п.] |
| 43 | +``` |
| 44 | + |
| 45 | +### Примеры: |
| 46 | + |
| 47 | +- `feat(auth): добавлена двухфакторная аутентификация` |
| 48 | +- `fix(api): исправлена ошибка 500 при обновлении профиля` |
| 49 | +- `docs(readme): обновлена инструкция по установке` |
| 50 | +- `refactor(ui): оптимизирована структура компонентов` |
| 51 | + |
| 52 | +**Популярные типы:** |
| 53 | +- `feat` — новая функциональность |
| 54 | +- `fix` — исправление бага |
| 55 | +- `docs` — только изменения в документации |
| 56 | +- `style` — изменения форматирования (пробелы, отступы) |
| 57 | +- `refactor` — рефакторинг без исправления багов/фич |
| 58 | +- `test` — добавление/обновление тестов |
| 59 | +- `chore` — прочие задачи (обновление зависимостей и т.д.) |
31 | 60 |
|
32 | | -Принимая участие, вы соглашаетесь, что ваш вклад будет лицензирован на условиях проекта. |
| 61 | +--- |
| 62 | + |
| 63 | +## 🤝 Кодекс поведения |
| 64 | + |
| 65 | +Мы придерживаемся [Contributor Covenant](https://www.contributor-covenant.org/) как нашего кодекса поведения. |
| 66 | + |
| 67 | +- Будьте вежливы и уважительны. |
| 68 | +- Избегайте токсичного поведения. |
| 69 | +- Уважайте чужое время и труд. |
33 | 70 |
|
34 | 71 | --- |
35 | 72 |
|
36 | | -Хочешь добавить секции про кодекс поведения, соглашения о коммитах или формат сообщений? |
| 73 | +## 📬 Сообщения об ошибках и предложения |
| 74 | + |
| 75 | +Если вы нашли баг или хотите предложить улучшение: |
| 76 | + |
| 77 | +1. Создайте issue с понятным заголовком. |
| 78 | +2. Опишите: |
| 79 | + - шаги воспроизведения (для багов) |
| 80 | + - что вы ожидаете |
| 81 | + - скриншоты, если нужно |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +## 📄 Лицензия |
| 86 | + |
| 87 | +Все вклады принимаются в соответствии с лицензией проекта (см. `LICENSE`). |
0 commit comments