Clarify README.md and make git-author script not print leading newlines

vmware-archive / git-author

An easy way to setup multiple authors based on `git commit --template`. It depends on git-together

BSD 3-Clause "New" or "Revised" License

30 stars 11 forks source link

Clarify README.md and make git-author script not print leading newlines #4

Closed amilkh closed 6 years ago

amilkh commented 6 years ago

@xinzweb if these are alright can we merge to master?

Also, another question is after setting up git author, do we still need to alias git-together, e.g. with adding the below line to ~/.bash_profile?

alias git=git-together

amilkh commented 6 years ago

Also, when soloing, an "Author:" is still added. Are we sure we want this?

 $ git log --pretty=full -1
 commit fef15b0319435ece09d40c9d3a810342c44c0cb2
 Author: Amil Khanzada <akhanzada@pivotal.io>
 Commit: Amil Khanzada <akhanzada@pivotal.io>

     centos-docker-setup: usability improvements + fix hwclock drift
+
+    Author: Amil Khanzada <akhanzada@pivotal.io>

xinzweb commented 6 years ago

Thanks a lot @amilkh. I tried to avoid having 'git-together' alias with 'git', since this will interfere other tools build on top of 'git'. To keep them separately, people can choose to use original 'git' behavior or 'git together' behavior.

Second, for solo author, I still prefer to have 'Author: ' there for following benefits:

Help preserve authorship even the author field got updated by 'git together' or other 'git duet' tools during rebase or amend
Easy for 3rd party tools to look for same pattern to look for author regardless how many people contributed to the commit.

Thanks, Shin

xinzweb commented 6 years ago

+1 on the README change, but not the code change. Please split them, and I will merge the README part in. Thanks.

amilkh commented 6 years ago

Thanks a lot @amilkh. I tried to avoid having 'git-together' alias with 'git', since this will interfere other tools build on top of 'git'. To keep them separately, people can choose to use original 'git' behavior or 'git together' behavior.

Discussed with David. Seems like we still need to do the alias for author rotation to happen automatically. What do you think?

amilkh commented 6 years ago

@xinzweb any thoughts?

xinzweb commented 6 years ago

@amilkh the git-together alias is already done with the git-together repo setup, so I don't want to include in this setup. It's people's choice to alias it or not. The current setup will allow git-author with git-together regardless it's aliased as git or not.

Great patch, let's get it in.

amilkh commented 6 years ago

@xinzweb got it thanks!