yihui / ideas

personal activities
http://yihui.name
6 stars 3 forks source link

Collaborate with me on Github #31

Closed yihui closed 6 years ago

yihui commented 12 years ago

here is a list of things that I'd like you to pay attention to when collaborating with me on Github:

  1. one commit does one job only; do not do several jobs with one commit; this is to make code review easier
  2. if one commit is supposed to fix one existing issue, put a message like fixes #n or closes #n in the commit message
  3. always use the --rebase option when pulling changes from the repository, e.g. git pull --rebase; this is to avoid unnecessary merges and make the tree cleaner
  4. I mainly use Ubuntu, and I'll be happy if you use *nix as well; Windows is fine, but EOL marker may be annoying (CRLF or LF)
  5. if there are too many changes, please select one subset of lines to commit at one time select lines to commit