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

proposal for commit log of binary files #3

Closed
marcoaccame opened this issue Sep 16, 2015 · 3 comments
Closed

proposal for commit log of binary files #3

marcoaccame opened this issue Sep 16, 2015 · 3 comments

Comments

@marcoaccame
Copy link
Contributor

The log of the commit should contain some basic information which can help one user to understand the content of the binary file.

My proposal, open for discussion, is the following.

  • first row of the log contains the board name and fw version, so that one can see most important info first.
  • in some rows below write info about when the built was done and the SHA of the used repositories. that may be useful to re-create the binary from source code.
  • finally add a comment about the differences in functionalities with the previously committed fw version.

An example is in SHA: 4b0356a

if we all follow some rule of the sort, the repository will be more clear.

The issue can interest @lornat75 @maggia80 @valegagge @ale-git @randaz81 @davege89

@traversaro
Copy link
Member

I suggest to also include a blank line between the first row of the commit message and remaining rows, so that some git-related tools can properly work. See http://chris.beams.io/posts/git-commit/#separate .

@marcoaccame
Copy link
Contributor Author

I agree Silvio, it is a good practice.

@marcoaccame
Copy link
Contributor Author

closing it. keep however in mind this mode of commit.

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

2 participants