diff --git a/app/src/main/res/values-ru-rRU/strings.xml b/app/src/main/res/values-ru-rRU/strings.xml index 6353b9af..34ef5fd3 100644 --- a/app/src/main/res/values-ru-rRU/strings.xml +++ b/app/src/main/res/values-ru-rRU/strings.xml @@ -18,8 +18,8 @@ О нас О Sparkles Команда - Переводчики - Разработчики + Переводчик + Разработчик Промоутер Дизайнер Настройки @@ -67,4 +67,4 @@ Закрыть другие Закрыть все - \ No newline at end of file + diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 97% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index b6c4c562..0d1d11e0 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -53,7 +53,7 @@ Go to the original repository where you want to propose your changes. Click on t > [!NOTE] > ### Additional Guidelines -> - **License**: Please adhere to our [License](license). +> - **License**: Please adhere to our [License](../license). > - **Issue Tracking**: If you encounter a bug or have a feature request, please open an issue in the repository. > - **Review Process**: After submitting your pull request, a project maintainer will review your changes. Be open to feedback and ready to make any necessary revisions. diff --git a/docs/CONTRIBUTING_RU.md b/docs/CONTRIBUTING_RU.md new file mode 100644 index 00000000..dbe58256 --- /dev/null +++ b/docs/CONTRIBUTING_RU.md @@ -0,0 +1,63 @@ +## Внесение вклада в Sparkles Редактор + +Спасибо за то, что вы решили внести вклад в Sparkles Редактор! Мы очень ценим вашу помощь за улучшение приложения. Пожалуйста, следуйте по данной инструкцию перед тем как начать. + +### Как внести свой вклад + +#### 1. Создайте форк репозитория +Чтобы внести свой вклад в данный проект, вам необходимо создать личную копию репозитория. Вы можете сделать это, нажав "Fork" в верхнем правом углу страницы репозитория. + +#### 2. Создайте клон форка +После того, как вы создали форк, вам необходимо создать клон репозитория на вашем устройстве: + +```bash +git clone https://github.com/Sparkleseditor/Sparkleseditor.git +cd Sparkleseditor +``` + +#### 3. Создайте новую ветку (необязательно) +Создайте новую ветку для новых изменений или исправлений ошибок: + +```bash +git checkout -b feature/название-ваших-изменений +``` + +#### 4. Внесите ваши изменения +Внесите ваши изменения в новой ветке. Убедитесь, что вы следуете стилю кодирования и соглашениям данного проекта. + +#### 5. Проверьте свои изменения +Перед тем, как зафиксировать изменения, убедитесь, что всё работает правильно. Запускайте существующие проверки и создавайте новые, если возможно. + +#### 6. Зафиксируйте свои изменения +Как только вы удовлетворены своим результатом, зафиксируйте их следующим образом: + +```bash +git commit -m "Детальное описание ваших изменений" +``` + +#### 7. Загрузите изменения в ваш форк +Загрузите изменения в ваш форк: + +1 +```bash +git push origin feature/название-ваших-изменений +``` +2 (Default) +```bash +git push origin main +``` + +> [!Warning] +> Github заблокировал вас на вашем устройстве? Новая политика Github требует токен аутентификации. Когда вы получите его, то сможете работать дальше как обычно. Обычно подобное происходит, если вы пытаетесь загрузить в репозиторий, не являясь её участником. +> https://github.com/settings/tokens/new + +#### 8. Предложите свои изменения +Откройте исходный репозиторий, куда вы хотите отправить свои изменения. Нажмите на "Pull Requests", затем на "New Pull Request". Выберите вашу ветку и отправьте предложение своих изменений. + +> [!Note] +> ### Дополнительные рекомендации +> - **Лицензия**: Пожалуйста, соблюдайте нашу [Лицензию](../license). +> - **Отслеживание проблем**: Если вы столкнулись с ошибкой или у вас есть запрос на обновление, пожалуйста, откройте проблему в репозитории. +> - **Процесс проверки**: После отправки предложения, участник проекта будет проверять ваши изменения. Будьте открыты для связи и готовы к выполнению различных изменений. + +Спасибо за ваш вклад! Вместе, мы сделаем Sparkles Редактор ещё лучше! diff --git a/README.md b/docs/README.md similarity index 84% rename from README.md rename to docs/README.md index 7b348593..baf0115b 100644 --- a/README.md +++ b/docs/README.md @@ -1,15 +1,18 @@ +**English** | [Русский](README_RU.md) + +---
- +

Sparkles Editor is an All-in-one Editor with Supporting full languages & Material Design 3


- + - +
diff --git a/docs/README_RU.md b/docs/README_RU.md new file mode 100644 index 00000000..35f301ac --- /dev/null +++ b/docs/README_RU.md @@ -0,0 +1,42 @@ +[English](README.md) | **Русский** + +--- + +
+ +

Sparkles является редактором Всё-В-Одном, +поддерживающее различные языки программирования и Material Design 3

+
+ + + + + + + + +
+ +## Особенности и список задач +- [ ] Хорошая кастомизация редактора кода +- [ ] Поддержка Python +- [x] Поддержка Java +- [x] Поддержка Markdown +- [ ] Поддержка Web языков ( HTML JavaScript CSS) +- [x] Поддержка терминала +- [x] Поддержка древовидной структуры файлов +- [x] Отличный интерфейс +- [x] Особенная тема Sparkles редактора + +## Как внести свой вклад +

Если вы хотите помочь нам в разработке, то убедитесь, что вы уважаете правила, создав отдельную ветку

+ +[CONTRIBUTING.md](CONTRIBUTING_RU.md). + +## Участники + + + + +
+