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

fixed the intro Doc. #1

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

fixed the intro Doc. #1

wants to merge 6 commits into from

Conversation

fydo23
Copy link
Contributor

@fydo23 fydo23 commented Jun 14, 2012

Let me know what you think. I broke it up and added a few things that dumb-down the process a bit so the next person doesn't spend a day accomplishing it. ;)

@kgrinberg
Copy link
Contributor

This is good, but I have a few suggestions:

  1. Squash the commits into one - it's really fixing one thing. Squashing will make it really easy to see the actual final copy (I had some comments on the prior versions, which I then saw the latter commits fixed). Take a look at:

http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
https://help.github.com/articles/interactive-rebase

  1. Make the commit message meaningful. "Update master" is not super-useful; "Updated the doc a bit..." is much better, so I'd either go with that, or even a little bit more specific about the changes (i.e. that they relate to vagrant.wsgi). Obviously the changes themselves are in the commit, so there's no need to go overboard and retype it all in the commit log. =) Just make it meaningful/useful.

  2. I think this typo was in my original, but since you're fixing that copy anyway - it says "director" where it should be "directory".

fydo23 added 3 commits June 15, 2012 14:07
included how to add a public key to github procedure to end of new-project.txt
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.

2 participants