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

feat: adding links to github contributing file #45

Closed
wants to merge 1 commit into from

Conversation

Lymah123
Copy link

This PR makes changes to .github contributing file.

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

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

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

Added to documentation?

  • 📜 README.md
  • 📓 docs.opensauced.pizza
  • 🍕 dev.to/opensauced
  • 📕 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?

@Lymah123
Copy link
Author

You can review PR @CBID2. I will be waiting for the feedback.

Copy link

@CBID2 CBID2 left a comment

Choose a reason for hiding this comment

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

It looks okay so far. @bdougie, what do you think?

@bdougie
Copy link
Member

bdougie commented Oct 13, 2023

I struggle to see the value for adding these links, especially gitpod.

This opens the door for other in-browser editors to also get added.

As written it seems like we are selling codespaces and gitpod. Showing is better telling. A better approach a one click link to open the editor but that already exist and it is when you type . While in the root of the project.

@CBID2
Copy link

CBID2 commented Oct 13, 2023

I struggle to see the value for adding these links, especially gitpod.

This opens the door for other in-browser editors to also get added.

As written it seems like we are selling codespaces and gitpod. Showing is better telling. A better approach a one click link to open the editor but that already exist and it is when you type . While in the root of the project.

Hi @bdougie. I was thinking back to my earlier experiences in open source, how errors would occur when I tried to setup projects locally in spite of following the contributing guide's directions. So, I pictured a beginner being in this situation, and found that virtual IDEs like Gitpod would be really helpful in getting these individuals ready to contribute. Also, you did recommend adding it to the .github repository

@Lymah123
Copy link
Author

I struggle to see the value for adding these links, especially gitpod.
This opens the door for other in-browser editors to also get added.
As written it seems like we are selling codespaces and gitpod. Showing is better telling. A better approach a one click link to open the editor but that already exist and it is when you type . While in the root of the project.

Hi @bdougie. I was thinking back to my earlier experiences in open source, how errors would occur when I tried to setup projects locally in spite of following the contributing guide's directions. So, I pictured a beginner being in this situation, and found that virtual IDEs like Gitpod would be really helpful in getting these individuals ready to contribute. Also, you did recommend adding it to the .github repository

Hi @CBID2 and @bdougie, I guess @bdougie wants us to focus on practical instructions rather than just providing links. Which I was thinking a step-by-step guide approach aligns with his suggestion. Let me know if I am wrong.

@bdougie bdougie closed this Mar 22, 2024
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.

3 participants