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

Update README.MD #175

Closed
wants to merge 1 commit into from
Closed

Update README.MD #175

wants to merge 1 commit into from

Conversation

alenbaby13
Copy link
Contributor

@alenbaby13 alenbaby13 commented Jul 3, 2024

Ticket Link


Related Links


Description


Steps to Reproduce / Test


Request


Response


Summary by CodeRabbit

  • Documentation
    • Updated URLs in the README file for tracking sources from gthb to github and mediums from repo to go-template for consistency.

Copy link

coderabbitai bot commented Jul 3, 2024

Walkthrough

The changes in the go-template repository's README file involve updating old URLs that used gthb and repo as URL parameters to use github and go-template instead. This improves consistency and accuracy in the tracking parameters.

Changes

File Change Summary
README.md Updated URL parameters from gthb to github and from repo to go-template for consistency.

Poem

In the README, links did roam,
From gthb they now call home,
Go-template flags now proudly wave,
URLs smart, they now behave,
Code by rabbits, neat and swift,
Every click, a precise gift! 🌐🐇

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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

sonarqube-ws bot commented Jul 3, 2024

Passed

Analysis Details

0 Issues

  • Bug 0 Bugs
  • Vulnerability 0 Vulnerabilities
  • Code Smell 0 Code Smells

Coverage and Duplications

  • Coverage No coverage information (95.70% Estimated after merge)
  • Duplications No duplication information (0.00% Estimated after merge)

Project ID: wednesday-solutions_go-template_AY4Ik1IUB2n8RRmGoUiD

View in SonarQube

Copy link

@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: 5

Outside diff range and nitpick comments (1)
README.MD (1)

34-34: Consider a different adverb to strengthen your wording.

The adverb "always" can be replaced to strengthen the wording.

- We’re always looking for people who value their work, so come and join us.
+ We’re constantly looking for people who value their work, so come and join us.
Tools
LanguageTool

[style] ~34-~34: Consider a different adverb to strengthen your wording.
Context: ...> ___ We’re always looking for people who value their work...

(ALWAYS_CONSTANTLY)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9e3bdf7 and d9d8480.

Files selected for processing (1)
  • README.MD (3 hunks)
Additional context used
Markdownlint
README.MD

1-1: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


5-5: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


25-25: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


37-37: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

LanguageTool
README.MD

[style] ~34-~34: Consider a different adverb to strengthen your wording.
Context: ...> ___ We’re always looking for people who value their work...

(ALWAYS_CONSTANTLY)

@@ -1,7 +1,7 @@
<img align="left" src="https://github.com/wednesday-solutions/go-template/blob/master/golang_template_github.svg" width="440" height="480" />
Copy link

Choose a reason for hiding this comment

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

Add alt text to images.

Images should have alternate text for accessibility.

- <img align="left" src="https://github.com/wednesday-solutions/go-template/blob/master/golang_template_github.svg" width="440" height="480" />
+ <img align="left" src="https://github.com/wednesday-solutions/go-template/blob/master/golang_template_github.svg" width="440" height="480" alt="Go Template Logo" />
- <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f5879492fafecdb3e5b0e75_wednesday_logo.svg">
+ <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f5879492fafecdb3e5b0e75_wednesday_logo.svg" alt="Wednesday Solutions Logo">
- <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f6ae88b9005f9ed382fb2a5_button_get_in_touch.svg" width="121" height="34">
+ <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f6ae88b9005f9ed382fb2a5_button_get_in_touch.svg" width="121" height="34" alt="Get in Touch Button">

Also applies to: 5-5, 25-25

Tools
Markdownlint

1-1: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

@@ -32,7 +32,7 @@
___

<span>We’re always looking for people who value their work, so come and join
us. <a href="https://www.wednesday.is/hiring">We are hiring!</a></span>
us. <a href="https://www.wednesday.is/hiring/?utm_source=github&utm_medium==go-template">We are hiring!</a></span>


Copy link

Choose a reason for hiding this comment

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

Remove multiple consecutive blank lines.

Multiple consecutive blank lines are not allowed.

- <br/>
+ <br/>

Committable suggestion was skipped due to low confidence.

Tools
Markdownlint

37-37: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

@@ -21,7 +21,7 @@
</p>

<div>
<a href="https://www.wednesday.is/contact-us?utm_source=gthb&utm_medium=repo&utm_campaign=serverless" target="_blank">
<a href="https://www.wednesday.is/contact-us?utm_source=github&utm_medium==go-template" target="_blank">
Copy link

Choose a reason for hiding this comment

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

Fix the utm_medium parameter in the URL.

There is an extra = in the utm_medium parameter.

-    <a href="https://www.wednesday.is/contact-us?utm_source=github&utm_medium==go-template" target="_blank">
+    <a href="https://www.wednesday.is/contact-us?utm_source=github&utm_medium=go-template" target="_blank">
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
<a href="https://www.wednesday.is/contact-us?utm_source=github&utm_medium==go-template" target="_blank">
<a href="https://www.wednesday.is/contact-us?utm_source=github&utm_medium=go-template" target="_blank">

@@ -32,7 +32,7 @@
___

<span>We’re always looking for people who value their work, so come and join
us. <a href="https://www.wednesday.is/hiring">We are hiring!</a></span>
us. <a href="https://www.wednesday.is/hiring/?utm_source=github&utm_medium==go-template">We are hiring!</a></span>
Copy link

Choose a reason for hiding this comment

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

Fix the utm_medium parameter in the URL.

There is an extra = in the utm_medium parameter.

- us. <a href="https://www.wednesday.is/hiring/?utm_source=github&utm_medium==go-template">We are hiring!</a></span>
+ us. <a href="https://www.wednesday.is/hiring/?utm_source=github&utm_medium=go-template">We are hiring!</a></span>
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
us. <a href="https://www.wednesday.is/hiring/?utm_source=github&utm_medium==go-template">We are hiring!</a></span>
us. <a href="https://www.wednesday.is/hiring/?utm_source=github&utm_medium=go-template">We are hiring!</a></span>

@@ -1,7 +1,7 @@
<img align="left" src="https://github.com/wednesday-solutions/go-template/blob/master/golang_template_github.svg" width="440" height="480" />

<div>
<a href="https://www.wednesday.is?utm_source=gthb&utm_medium=repo&utm_campaign=gotemplate" align="left" style="margin-left: 0;">
<a href="https://www.wednesday.is?utm_source=github&utm_medium==go-template" align="left" style="margin-left: 0;">
Copy link

Choose a reason for hiding this comment

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

Fix the utm_medium parameter in the URL.

There is an extra = in the utm_medium parameter.

-  <a href="https://www.wednesday.is?utm_source=github&utm_medium==go-template" align="left" style="margin-left: 0;">
+  <a href="https://www.wednesday.is?utm_source=github&utm_medium=go-template" align="left" style="margin-left: 0;">
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
<a href="https://www.wednesday.is?utm_source=github&utm_medium==go-template" align="left" style="margin-left: 0;">
<a href="https://www.wednesday.is?utm_source=github&utm_medium=go-template" align="left" style="margin-left: 0;">

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.

None yet

2 participants