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

Better discord link #818

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Better discord link #818

merged 1 commit into from
Oct 1, 2024

Conversation

paulgb
Copy link
Member

@paulgb paulgb commented Oct 1, 2024

Before:

image

After:

image

Copy link

vercel bot commented Oct 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
plane ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 0:23am

Copy link
Contributor

coderabbitai bot commented Oct 1, 2024

Walkthrough

The pull request introduces updates to the README.md file, focusing on the styling and links associated with the Plane logo. A typographical error in the positioning style was corrected from "postion" to "position." The logo links have been adjusted to function correctly in both light and dark modes. Additionally, the Discord badge has been updated to utilize a dynamic link that reflects the server's ID, replacing the previously static label. The core content that outlines Plane's functionality and use cases remains unchanged, along with the links to further documentation and resources. No alterations were made to the declarations of exported or public entities in this diff.

Poem

🐇 In the README, changes hop,
A logo's link, a style non-stop.
From "postion" fixed to "position" bright,
Discord's badge now shines just right!
With every tweak, our project grows,
A rabbit's cheer, as progress flows! 🌟


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.

@paulgb paulgb requested a review from rolyatmax October 1, 2024 00:23
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 and nitpick comments (1)
README.md (1)

Line range hint 1-7: Fix typo and consider using pure Markdown

There's a typo in the HTML at the beginning of the file:

-<div style="postion: relative; width: 337px; height: 110px;">
+<div style="position: relative; width: 337px; height: 110px;">

Also, consider if pure Markdown could achieve the same result as the current HTML + Markdown mix. This could improve readability and maintainability of the README.

🧰 Tools
🪛 LanguageTool

[style] ~10-~10: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 2026 characters long)
Context: ...ps://hub.docker.com/r/plane/plane/tags) Build Docker Image Tests [![Chat on Discord](https://img.shields.io...

(EN_EXCESSIVE_EXCLAMATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1f919cd and 1e6b50d.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

13-13: LGTM! Consider minor improvements and verify the invite link.

The updated Discord badge looks good and aligns with the PR objectives. The dynamic link now reflects the server's ID, which is an improvement over the static label.

Some suggestions for further enhancement:

  1. Consider adding alt text for accessibility, e.g., ![Discord](https://img.shields...).
  2. For easier maintenance, you could extract the Discord server ID to a variable if this README is generated from a template.

Please verify that the Discord invite link (https://discord.gg/N5sEpsuhh9) is correct and active. You can use the following script to check the link's validity:

✅ Verification successful

Please verify the final destination of the Discord invite link by following the redirect. You can use the following script to check the final status code:


Discord invite link verified as valid and active.

The Discord invite link (https://discord.gg/N5sEpsuhh9) has been successfully verified and is active, ensuring that the badge directs users correctly.

For further improvement:

  1. Consider adding alt text for accessibility, e.g., ![Discord](https://img.shields.io/discord/939641163265232947?color=404eed&label=discord).
  2. To enhance maintainability, extract the Discord server ID to a variable if the README is generated from a template.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the Discord invite link

# Test: Check if the Discord invite link is valid
response=$(curl -s -o /dev/null -w "%{http_code}" https://discord.gg/N5sEpsuhh9)
if [ $response -eq 200 ]; then
  echo "Discord invite link is valid"
else
  echo "Discord invite link returned status code: $response"
fi

Length of output: 209


Script:

# Description: Follow redirects and verify the final status of the Discord invite link

# Test: Check the final status code after following redirects
response=$(curl -s -o /dev/null -w "%{http_code}" -L https://discord.gg/N5sEpsuhh9)
if [ $response -eq 200 ]; then
  echo "Discord invite link is valid and active."
else
  echo "Discord invite link returned final status code: $response"
fi

Length of output: 202

@paulgb paulgb merged commit 2e2c319 into main Oct 1, 2024
6 checks passed
@paulgb paulgb deleted the paulgb/better-discord-link branch October 1, 2024 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants