diff options
| author | Ævar Arnfjörð Bjarmason <avar@cpan.org> | 2010-04-20 18:36:51 +0000 |
|---|---|---|
| committer | Ævar Arnfjörð Bjarmason <avar@cpan.org> | 2010-04-20 18:36:51 +0000 |
| commit | 1a5f98ea6257ef63e515f48e05311fba2cdd7dbc (patch) | |
| tree | 3ad4c6ce1090669e2edced05ebb927e0741bf6a8 /pod/perlrepository.pod | |
| parent | 0be741b53900848403d51758327b066a4784699c (diff) | |
| download | perl-1a5f98ea6257ef63e515f48e05311fba2cdd7dbc.tar.gz | |
Commit messages should start with a ~50 char summary
The first sentence is stolen from Git's own
Documentation/SubmittingPatches. We have a lot of commit messages that
overflow `git log --pretty=oneline', but it wouldn't hurt if we change
that sooner rather than later.
Diffstat (limited to 'pod/perlrepository.pod')
| -rw-r--r-- | pod/perlrepository.pod | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/pod/perlrepository.pod b/pod/perlrepository.pod index 516e76289a..f23d6a6de1 100644 --- a/pod/perlrepository.pod +++ b/pod/perlrepository.pod @@ -439,8 +439,16 @@ you need to do. As you craft each patch you intend to submit to the Perl core, it's important to write a good commit message. -Your commit message should start with a description of the problem that -the patch corrects or new functionality that the patch adds. +The first line of the commit message should be a short description and +should skip the full stop. It should be no longer than the subject +line of an E-Mail, 50 characters being a good rule of thumb. + +A lot of Git tools (Gitweb, GitHub, git log --pretty=oneline, ..) will +only display the first line (cut off at 50 characters) when presenting +commit summaries. + +The commit message should include description of the problem that the +patch corrects or new functionality that the patch adds. As a general rule of thumb, your commit message should let a programmer with a reasonable familiarity with the Perl core quickly understand what |