Skip to content

First line should summary why this commit was necessary #62

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

Open
baby-gnu opened this issue May 21, 2020 · 0 comments
Open

First line should summary why this commit was necessary #62

baby-gnu opened this issue May 21, 2020 · 0 comments

Comments

@baby-gnu
Copy link

Hello.

Doing some Git log archeology quite often, I always struggle to find why a commit was done rather than what it does:

  • a first line to summary why this commit was done
  • a longer description to make explicit the context of the why given in the first line. This description summary how things were done.
  • if necessary, a list of files with a summary of what was wrong specifically to this file and the tricky parts

This way:

  • git log --oneline master shows why pull requests where accepted
  • git show aaafffeee shows what is done by a commit

So, instead of:

Use InventoryBackendPool to retrieve inventory backend

I think it's better to have

`Inventory` is slow and heavy for the backend

We call the backend several times and `Inventory` open and close a connection
at each call which is slow to execute and add load to the backend to open
connections and authenticate them.

We switch the part `Foo` of the software to `InventoryBackendPool` 
which open once a connection pool with the backend and maintain them open
and reopen them if they close unexpectidly.

Ref: #42

Regards.

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

1 participant