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

Expand instructions on how to use the GitHub web UI (eg "Improve this content on GitHub") #21

Open
Asartea opened this issue Oct 26, 2023 · 4 comments
Assignees

Comments

@Asartea
Copy link
Contributor

Asartea commented Oct 26, 2023

In the contributing guide section on the curriculum, we mention that "If you're new to contributing to open-source, or if you just want to make a really quick PR, you can click the "Improve this lesson on GitHub" link", which leads a user to GitHub's web UI for editing.

This interface isn't necessarily immediately intuitive, however, and it would be nice if we made it slightly clearer how it's supposed to work (ref eg this Discord discussion from today)

I think the best way to do this would be to add step-by-step instructions on how to make a commit + PR via the web UI, optionally enhanced with some images/gifs.

This primarily concerns the curriculum repo, so I could also see an argument for making a new file there instead of adding it to the global contributing.md file

@CouchofTomato
Copy link
Member

Hey @Asartea

It looks from the discussion that it was supported. I've asked maintainers if anyone has a view on this and will check back in shortly. I'm assigning to myself for now only to remind myself to follow up on this.

@CouchofTomato CouchofTomato self-assigned this Oct 27, 2023
@Maxwell011
Copy link

Hello @Asartea have you done it ?

@Asartea
Copy link
Contributor Author

Asartea commented Feb 5, 2024

This is waiting on @CouchofTomato

and will check back in shortly. I'm assigning to myself for now only to remind myself to follow up on this.

Press X to doubt (/j)

@CouchofTomato
Copy link
Member

@Asartea I did reach out to the team. I didn't get much feedback at the time and then life gets in the way.

I'm not against showing people how to use the web ui in github as long as we don't distract from learning how to do it in git because not all companies will use github.

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

No branches or pull requests

3 participants