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

Rename "Twitter" to "X (formerly Twitter)" #20694

Merged
merged 3 commits into from
Jun 26, 2024

Conversation

spacegaier
Copy link
Member

@spacegaier spacegaier commented May 1, 2024

Breaking change

Proposed change

image

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • New Features

    • Updated social media references to reflect the rebranding of Twitter to X.
    • Added new community links for Forums, Chat, Blog, and Newsletter.
  • Improvements

    • Enhanced localization support by replacing static text with dynamic text using hass.localize() for better language support.

@silamon silamon marked this pull request as draft May 6, 2024 06:30
src/translations/en.json Outdated Show resolved Hide resolved
@silamon silamon marked this pull request as ready for review June 21, 2024 17:30
Copy link
Contributor

coderabbitai bot commented Jun 21, 2024

Warning

Rate limit exceeded

@silamon has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 11 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between cd01540 and 72c7026.

Walkthrough

The updates primarily focus on rebranding from Twitter to X across various components. This involves changing static text references, updating URLs, and adding new localization keys to support dynamic content generation for community links.

Changes

File/Folder Change Summary
src/panels/config/dashboard/ha-config-dashboard.ts Replaced static link text (e.g., "Twitter") with dynamic text using the hass.localize() function for better localization support.
src/translations/en.json Updated existing "twitter" key value from "Twitter" to "X (formerly Twitter)" and added new keys for various community links such as "join_forums", "join_chat", etc.
src/onboarding/dialogs/community-dialog.ts Updated the Twitter link to point to X (https://x.com/home_assistant), changed the image source to logo_x.svg, and updated the localization key for the link text.

Assessment against linked issues

Objective Addressed Explanation
Update the community tip to point to X instead of Twitter (20634)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 comments (1)
src/panels/config/dashboard/ha-config-dashboard.ts (1)

Line range hint 159-159: Remove the non-null assertion to avoid potential runtime errors.

Using non-null assertions can lead to unexpected runtime errors if the object turns out to be null. It's safer to handle the possibility of null values explicitly.

- subscribeRepairsIssueRegistry(this.hass.connection!, (repairs) => {
+ if (this.hass.connection) {
+   subscribeRepairsIssueRegistry(this.hass.connection, (repairs) => {

@@ -67,7 +67,7 @@ const randomTip = (hass: HomeAssistant, narrow: boolean) => {
href=${documentationUrl(hass, `/twitter`)}
target="_blank"
rel="noreferrer"
>Twitter</a
>X (formerly Twitter)</a
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider using a translation key for the social media platform name.

The change directly modifies the displayed text within the code, which can lead to issues with internationalization. It would be better to use a translation key defined in a localization file, which then references "X (formerly Twitter)".

- >X (formerly Twitter)</a
+ >${this.hass.localize('social.twitter')}</a
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
>X (formerly Twitter)</a
>${this.hass.localize('social.twitter')}</a

@silamon silamon enabled auto-merge (squash) June 21, 2024 17:38
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: 0

Outside diff range comments (1)
src/panels/config/dashboard/ha-config-dashboard.ts (1)

Line range hint 159-159: Consider removing the non-null assertion.

The use of a non-null assertion here is flagged by static analysis as potentially risky. Non-null assertions can lead to runtime errors if assumptions about non-nullability prove incorrect. Consider checking for null or using optional chaining.

- subscribeRepairsIssueRegistry(this.hass.connection!, (repairs) => {
+ subscribeRepairsIssueRegistry(this.hass.connection, (repairs) => {

@silamon silamon disabled auto-merge June 22, 2024 14:14
@bramkragten bramkragten merged commit 1821119 into home-assistant:dev Jun 26, 2024
13 checks passed
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.

Community tip - Rename Twitter to X
4 participants