Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

White changelog #133

Merged
merged 4 commits into from
Dec 6, 2024
Merged

White changelog #133

merged 4 commits into from
Dec 6, 2024

Conversation

Spatison
Copy link
Member

@Spatison Spatison commented Dec 2, 2024

Описание PR

Отдельный ченжлог для контента вайта. Нужно поменять CHANGELOG_DIR на WhiteChangelog


Изменения

🆑

  • add: Отдельный ченжлог для контента вайта

@Spatison Spatison requested a review from Remuchi December 2, 2024 18:49
@Spatison Spatison self-assigned this Dec 2, 2024
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Процесс

В классе LobbyState, расположенном в Content.Client/Lobby/LobbyState.cs, внесены изменения, касающиеся обработки записей в журнале изменений. Метод PopulateChangelog был обновлён для изменения способа получения данных журнала изменений, заменив поиск записи с названием "Changelog" на "WhiteChangelog". Количество записей, отображаемых из журнала изменений, было уменьшено с 5 до 3. Эти изменения затрагивают отображение журнала изменений в лобби, но структура метода остаётся прежней, без изменений в сигнатурах методов или общей структуре класса.

Изменения

Файл Изменения
Content.Client/Lobby/LobbyState.cs Обновлён метод PopulateChangelog: изменён поиск на "WhiteChangelog", количество записей уменьшено с 5 до 3.
Resources/Changelog/Changelog.yml Обновлён журнал изменений с множеством новых записей о модификациях, исправлениях и добавлениях.
Resources/Changelog/WhiteChangelog.yml Добавлены новые записи о системах и предметах, исправлениях и изменениях в механике игры.
Resources/Locale/en-US/_white/changelog/changelog-window.ftl Добавлена строка для заголовка вкладки журнала изменений: "White Dream".
Resources/Locale/ru-RU/_white/changelog/changelog-window.ftl Добавлена строка для заголовка вкладки журнала изменений: "White Dream".

Возможно связанные PR

  • [Port] Lobby / Лобби #47: Изменения в классе LobbyState, касающиеся обработки записей журнала изменений, непосредственно связаны с добавлением кнопки "Changelog" в пользовательском интерфейсе лобби, как описано в PR [Port] Lobby / Лобби #47.
  • [Fix] Localizations / Локализация #92: Хотя в основном сосредоточен на исправлениях локализации, этот PR затрагивает вопросы, которые могут повлиять на то, как информация о журнале изменений представляется пользователям, что делает его актуальным для изменений в LobbyState.

Предложенные метки

Changes: Documentation

Предложенные рецензенты

  • DVOniksWyvern
  • Remuchi

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)
Content.Client/Lobby/LobbyState.cs (2)

Line range hint 244-256: Рассмотрите добавление конфигурируемого количества записей

Изменение для использования "WhiteChangelog" корректно реализовано, но жёстко заданное ограничение в 3 записи может быть недостаточным для пользователей. Рекомендуется сделать это значение настраиваемым через конфигурацию.

-                .Take(3);
+                .Take(_configurationManager.GetCVar(CCVars.LobbyChangelogEntries));

Line range hint 244-256: Необходимо локализовать текст интерфейса

Текст "White Dream" жёстко закодирован на английском языке. Рекомендуется:

  1. Перенести текст в локализационные файлы
  2. Вынести настройки шрифта в стили UI
-Lobby!.LabelName.SetMarkup("[font=\"Bedstead\" size=20] White Dream [/font]");
+Lobby!.LabelName.SetMarkup(Loc.GetString("lobby-label-name"));
Resources/Changelog/WhiteChangelog.yml (1)

1-846: Рекомендуется добавить валидацию схемы YAML

Для обеспечения корректности формата changelog'а рекомендуется добавить схему YAML и валидацию при коммите.

Хотите, чтобы я помог создать схему YAML и настроить валидацию?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 29ce583 and d78dce6.

📒 Files selected for processing (5)
  • Content.Client/Lobby/LobbyState.cs (2 hunks)
  • Resources/Changelog/Changelog.yml (0 hunks)
  • Resources/Changelog/WhiteChangelog.yml (1 hunks)
  • Resources/Locale/en-US/_white/changelog/changelog-window.ftl (1 hunks)
  • Resources/Locale/ru-RU/_white/changelog/changelog-window.ftl (1 hunks)
💤 Files with no reviewable changes (1)
  • Resources/Changelog/Changelog.yml
✅ Files skipped from review due to trivial changes (2)
  • Resources/Locale/ru-RU/_white/changelog/changelog-window.ftl
  • Resources/Locale/en-US/_white/changelog/changelog-window.ftl

Resources/Changelog/WhiteChangelog.yml Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Dec 2, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d78dce6 and c6b7746.

📒 Files selected for processing (1)
  • Resources/Changelog/WhiteChangelog.yml (1 hunks)
🔇 Additional comments (3)
Resources/Changelog/WhiteChangelog.yml (3)

1-861: Необходимо обеспечить консистентность записей

В файле обнаружены те же проблемы, что были отмечены ранее:

  1. Некоторые записи содержат только русский текст без английского перевода
  2. Формат двуязычных сообщений не унифицирован

1-861: Проверьте хронологический порядок записей

Все записи должны быть отсортированы по времени в порядке убывания (от новых к старым). Рекомендуется проверить правильность сортировки.


790-814: 🛠️ Refactor suggestion

Используйте двуязычный формат для всех записей

Записи с ID 89 содержат только русский текст. Рекомендуется добавить английские переводы и использовать единый формат:

  - type: Tweak
-   message: Швабра теперь моет весь тайл
+   message: >-
+     Mop now cleans the entire tile / Швабра теперь моет весь тайл

Likely invalid or redundant comment.

Resources/Changelog/WhiteChangelog.yml Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Dec 4, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@Remuchi Remuchi merged commit c545e62 into master Dec 6, 2024
8 checks passed
@Remuchi Remuchi deleted the changelog branch December 6, 2024 17:46
AwareFoxy pushed a commit to AwareFoxy/wwdpublic that referenced this pull request Dec 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants