Skip to content
This repository has been archived by the owner on May 25, 2023. It is now read-only.

fix: broken link for contributing guide #1137

Merged
merged 1 commit into from
Aug 25, 2021
Merged

Conversation

MukulKolpe
Copy link
Contributor

@MukulKolpe MukulKolpe commented Aug 25, 2021

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

  • ♻️ Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • 👷 Optimization
  • 📝 Documentation Update
  • 🔖 Release
  • 🚩 Other

Description

The link in the README.md for contributing guide was broken which I replaced with https://docs.opensauced.pizza/contributing/getting-started/

Related Tickets & Documents

Closes #1136

Mobile & Desktop Screenshots/Recordings

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 readme
  • 📜 contributing.md
  • 📓 docs
  • 📕 storybook
  • 🙅 no documentation needed

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

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

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first Pull Request and thanks for taking the time to improve Open Sauced! ❤️! 🎉🍕
Say hello by joining the conversation in our Discord

@mtfoley
Copy link
Contributor

mtfoley commented Aug 25, 2021

@0-vortex @filiptronicek I know the guide says to name a new branch according to what the PR does (e.g. "1136-fix-contributing-link"). Also don't know if this PR ought to have "docs:" prefix for semantic release.

@bdougie
Copy link
Member

bdougie commented Aug 25, 2021

@0-vortex @filiptronicek I know the guide says to name a new branch according to what the PR does (e.g. "1136-fix-contributing-link"). Also don't know if this PR ought to have "docs:" prefix for semantic release.

I think it is fine as-is. Because it is a link fix, I think bug-fix works for me. It is also a good practice to not work on your fork's main branch. In the event @MukulKolpe's contributes again, you will find there is a chance your branch may run into merge conflicts or similar issues.

I added a note to address this in the docs updates. open-sauced/docs#11 (comment)

@bdougie bdougie self-requested a review August 25, 2021 02:17
Copy link
Member

@bdougie bdougie left a comment

Choose a reason for hiding this comment

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

LGTM

@0-vortex 0-vortex merged commit 5dfcea3 into open-sauced:main Aug 25, 2021
github-actions bot pushed a commit that referenced this pull request Aug 25, 2021
### [0.26.1](v0.26.0...v0.26.1) (2021-08-25)

### Bug Fixes

* contributing guide link fixed ([#1137](#1137)) ([5dfcea3](5dfcea3))
@github-actions
Copy link
Contributor

🎉 This PR is included in version 0.26.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: contributing guide link is broken
4 participants