Skip to content

User proper commit messages on GitHub #20

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

Closed
marcelstoer opened this issue Jun 29, 2017 · 3 comments
Closed

User proper commit messages on GitHub #20

marcelstoer opened this issue Jun 29, 2017 · 3 comments

Comments

@marcelstoer
Copy link
Contributor

I believe this says it all..

useless-commit-messages

It's not practical to open each commit to figure out what the changes actually were. The first line, ideally no more than 50 chars, should contain the essence of the commit.

@wujiangang
Copy link
Contributor

Sometimes, the commit header cannot describe all modifications, since we will sync several changes from our internal gitlab, so just take this as a merge. If you want to know the changes well, use git log will show more info.

@marcelstoer
Copy link
Contributor Author

since we will sync several changes from our internal gitlab

I suspected that this is the reason but it doesn't have to be that way. GitLab can be told to automatically push changes to a remote repo such as GitHub.

If you want to know the changes well, use git log

I know, but for casual observers (what most non-SDK developers are) this isn't practical because you'd have to clone the repository first.

You write useful release notes for people who are interested in the changes between release N and release N+1. Thanks for that. If I want to figure out what the changes since the latest release are I would look at the commit history as shown above.

@wujiangang
Copy link
Contributor

The github repo is not a mirror of gitlab repo, so cannot use the way you provide. Now, it's some inconvenient for you, i will modify the commit way, thanks for your advise.

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

No branches or pull requests

3 participants