open-sauced / hot

πŸ•The site that recommends the hottest projects on GitHub.
https://hot.opensauced.pizza
MIT License
418 stars 145 forks source link

docs(readme): fix typo and unformatted link #447

Closed Balastrong closed 1 year ago

Balastrong commented 1 year ago

What type of PR is this? (check all applicable)

Description

Fixed a typo and a broken link on README.md

(prettier also fixed some whitespaces/empty lines, I'd keep the change)

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

Added to documentation?

[optional] Are there any post-deployment tasks we need to perform?

Before image

After image

[optional] What gif best describes this PR or how it makes you feel?

netlify[bot] commented 1 year ago

Deploy Preview for hot-sauced-ui ready!

Name Link
Latest commit 20e73e41d9de74a13905294c12586d665dd16fd3
Latest deploy log https://app.netlify.com/sites/hot-sauced-ui/deploys/63e553b294efa800087af792
Deploy Preview https://deploy-preview-447--hot-sauced-ui.netlify.app/
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Balastrong commented 1 year ago

Hey @TAKANOME-DEV, thanks for the review!

I read the contribution guidelines before creating the PR, did I miss something in particular?

The thing that comes to my mind is that I didn't create an issue, but the page says both preferred and required:

We actively welcome your pull requests, however linking your work to an existing issue is preferred.

and

Unsolicited code is welcomed, but an issue is required for an announcement your intentions. PR's without a linked issue will be marked invalid and closed.

I didn't create one because it was only a typo and I thought it was ok. Sorry if this was required!

takanome-dev commented 1 year ago

The thing that comes to my mind is that I didn't create an issue, but the page says both preferred and required:

We actively welcome your pull requests, however linking your work to an existing issue is preferred.

and

Unsolicited code is welcomed, but an issue is required for an announcement your intentions. PR's without a linked issue will be marked invalid and closed.

Yeah, you're :100: right. Thanks for taking the time to read the guidelines.

Having the preferred and required may be a little bit confusing. Maybe an issue can be opened around that πŸ™‚

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 2.31.0-beta.6 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

bdougie commented 1 year ago

@Balastrong would be able to create a highlight about your work on this fix?

https://opensauced.pizza/blog/social-coding-is-back

Balastrong commented 1 year ago

Here it is! :D

https://insights.opensauced.pizza/user/Balastrong

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 2.31.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: