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

Screenshot snippet "friendliness" #557

Closed
plamoni opened this issue Mar 16, 2024 · 6 comments · Fixed by #558
Closed

Screenshot snippet "friendliness" #557

plamoni opened this issue Mar 16, 2024 · 6 comments · Fixed by #558
Labels
chore Something that needs to be updated good first issue Good for newcomers

Comments

@plamoni
Copy link
Member

plamoni commented Mar 16, 2024

Our current snippet reads:

Pictures of code are hard to read and cannot be copied into a local IDE for debugging. Please send your actual code or a link to your repository, instead of a picture.

This response could come across as intimidating to people who are band new and might not know what a repository is or how to post a code block on Discord.

I propose we update the language and provide links and be more positive. Proposed update:

Photos/screenshots of an error can be helpful in diagnosing an issue/bug; however, it also helps to provide the complete source code so that we can debug it locally. You can use a discord code block, GitHub Gist, GitHub repository, or PasteBin. Thanks!

Photos/screenshots of an error can be helpful in diagnosing an issue/bug; however, it also helps to provide the complete source code so that we can debug it locally. You can use a [discord code block](<https://gist.github.com/matthewzring/9f7bbfd102003963f9be7dbcf7d40e51#code-blocks>), [GitHub Gist](<https://gist.github.com/>), [GitHub repository](<https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository>), or [PasteBin](<https://pastebin.com/>). Thanks!

Thoughts?

@kabirgaire0
Copy link

kabirgaire0 commented Mar 16, 2024

I was on the programming-help channel on freecodecamp.org and a beginner coder was asking a question to a very basic html problem he was having while finishing a step on a learning course on a website. So like every beginner does every time they get stuck, he asked a question with the screenshot. The bot then responded with very difficult words like debugging and repository which no beginner is expected to know. So I hope we could find a way to not scare beginners with those difficult words or maybe make the difficult words into a link that opens up a site with explanation. It would be even better if there was a link you could click in the end of the message that would route people to a site that asks you what your skill level is, and then teach you proper ways of asking questions or ethics or something.

Thanks for reading, hope something clicks in someone's mind or someone gets some ideas from this.

MOD EDIT: converted to proper English from e-girl uwu speak.

@jeremylt
Copy link
Member

Photos/screenshots of an error can be helpful, but it also helps to provide the complete code. Posting the code helps us help you better!

Maybe this simplified wording?

@plamoni
Copy link
Member Author

plamoni commented Mar 16, 2024

Photos/screenshots of an error can be helpful, but it also helps to provide the complete code. Posting the code helps us help you better!

Maybe this simplified wording?

I want to provide people with links on how they might "post the code," so that it's more actionable. But I'm okay with the other adjustments.

@jeremylt
Copy link
Member

Yeah, I liked the sentence with the links too

@plamoni
Copy link
Member Author

plamoni commented Mar 16, 2024

Updated:

Photos/screenshots of an error can be helpful, but it also helps to provide the complete code. Posting the code helps us help you better!

You can use a discord code block, GitHub Gist, GitHub repository, or PasteBin.

Photos/screenshots of an error can be helpful, but it also helps to provide the complete code. Posting the code helps us help you better!

You can use a [discord code block](<https://gist.github.com/matthewzring/9f7bbfd102003963f9be7dbcf7d40e51#code-blocks>), [GitHub Gist](<https://gist.github.com/>), [GitHub repository](<https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository>), or [PasteBin](<https://pastebin.com/>).

@plamoni plamoni added good first issue Good for newcomers chore Something that needs to be updated labels Mar 16, 2024
@naomi-lgbt
Copy link
Member

For interested contributors, the line that will need to be updated is here:

https://github.com/freeCodeCamp/discord-bot/blob/87d00eca6c1e8bc3639cff86530a569f2ab97335/src/config/Tags.ts#L7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Something that needs to be updated good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants