This is a rough outline of what a contributor's workflow looks like:
Thanks for your contributions!
We follow a rough convention for commit messages that is designed to answer two questions: what changed and why. The subject line should feature the what and the body of the commit should describe the why.
utility: introduce rpc_holder This is a wrapper of dsn_message_t. It manages the lifetime follow RAII. Fix #10
The format can be described more formally as follows:
<subsystem>: <what changed> <BLANK LINE> <why this change was made> <BLANK LINE> <footer>(optional)
The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
If the change affects more than one subsystem, you can use comma to separate them like util/codec,util/types:
.
If the change affects many subsystems, you can use *
instead, like *:
.
For the why part, if no specific reason for the change, you can use one of some generic reasons like “Improve documentation.”, “Improve performance.”, “Improve robustness.”, “Improve test coverage.”