Skip to content

Commit 25240d5

Browse files
committed
Added instructions on merging branches and making comments to README.
1 parent 6eeca98 commit 25240d5

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,18 @@ use proper source control etiquette:
7373
git checkout --track -b msporny origin/msporny
7474

7575
2. Unless you know what you are doing, always ask before merging your
76-
branch into master. If you don't know how to do git merges, ask somebody
77-
else to do the merge for you.
78-
79-
76+
branch into master. If you're afraid of messing something up, ask somebody
77+
else to do the merge for you. You can perform a merge yourself by doing
78+
the following:
79+
80+
git checkout master
81+
git pull
82+
git checkout YOUR_GITHUB_USERNAME
83+
git merge master
84+
85+
3. Be fairly verbose with your check-in messages as other people will be
86+
reading them to understand the gist of your changes. Your comments may also
87+
eventually be merged into the master branch. Checkin messages like
88+
"Fixed typo." are awful because they require the person that is viewing
89+
the log to go into the source changes to see what you fixed. Comments
90+
like "Fixed a typo in the <object> element to address bug# 1234" are better.

0 commit comments

Comments
 (0)