diff options
| author | Valentin Rothberg <vrothberg@suse.com> | 2018-10-29 10:50:03 +0100 |
|---|---|---|
| committer | Valentin Rothberg <vrothberg@suse.com> | 2018-10-29 13:13:34 +0100 |
| commit | a36974585f67171bafed13a6a972364371530d1b (patch) | |
| tree | 249143c8ca939af35580863bb8a601495b286e2d /transfer.md | |
| parent | 49555721ec84ca630e8fbbf32a400e523c477439 (diff) | |
| download | podman-a36974585f67171bafed13a6a972364371530d1b.tar.gz podman-a36974585f67171bafed13a6a972364371530d1b.tar.bz2 podman-a36974585f67171bafed13a6a972364371530d1b.zip | |
CONTRIBUTING.md: add section about describing changes
Add a section about describing changes in commit messages. GitHub tends
to drive the large part of discussions and change descriptions to the
corresponding pull requests and issues, but such information is lost in
the git history. Not providing sufficient information in commit
messages is painful for reviewing and can cause issues while debugging.
It also complicates studying source code, where reading commit messages
and the code's git history is a common approach to better understand the
code.
Following the descriptions should be enforced by the maintainers of the
libpod project. Pull requests containing commits without proper
descriptions should not be merged.
This change bases on the documentation of the Linux kernel v4.17:
https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html
Signed-off-by: Valentin Rothberg <vrothberg@suse.com>
Diffstat (limited to 'transfer.md')
0 files changed, 0 insertions, 0 deletions