thinkful/guide-github-pull-request

An intro to GitHub Pull Requests guide created by Thinkful

guide-github-pull-request's Issues

Discuss guide structure

@Jenius just went through the guide and updated README + added some pictures + encouraged readers to submit their own PR.

What do you think?

/edit: I think it would be good to encourage readers to open an issue "Add <name> to <file>". Then have them fork the repo, create a commit and then submit a PR. I can review the PRs on a daily / weekly basis and merge them as they come 😄

VIM modes

Hey, loving the guide, one thing though

I see you encouraging VIM and then pointing people to a cheat sheet, but I'd like to point out a famous joke:

"how do you produce a random string?"
"put an IDE user in front of VIM and ask them to quit"

With this in mind, I think it would be really worth adding something as simple as explaining that VIM has 2 common modes... or at least telling them to press ESC so they flip between typing commands and typing content. It's not very clear from the cheet sheet.

Prerequisites

Hey, might be worth adding a few such as:

• familiarity with Command Line
• created git repositories before
• love of ice cream

Added new name

Added my name to the list

git clone instructions are broken

The line in the tutorial which instructs the reader to clone the forked repo don't work until you realize that the name of the repository is actually "guide-github-pull-request" (not "guides-...."). I added a pull request which fixes this.