diff options
author | Josh Stone <jistone@redhat.com> | 2009-02-19 20:00:31 -0800 |
---|---|---|
committer | Josh Stone <jistone@redhat.com> | 2009-02-19 20:00:31 -0800 |
commit | 377f3fa917795a4f39fbf8f22b20b0385eee13c1 (patch) | |
tree | 866840561cc30472ee84284af2be50e4b0fef7e4 /HACKING | |
parent | 398edb63c89f853606f68b316bb6528e2f9d76da (diff) | |
download | systemtap-steved-377f3fa917795a4f39fbf8f22b20b0385eee13c1.tar.gz systemtap-steved-377f3fa917795a4f39fbf8f22b20b0385eee13c1.tar.xz systemtap-steved-377f3fa917795a4f39fbf8f22b20b0385eee13c1.zip |
Update guidelines for the ChangeLog-less world
Getting rid of ChangeLogs doesn't mean that we get a free ticket -- we
now need to be more diligent about providing meaningful commit messages.
I've updated the HACKING file with a first draft of new guidelines, but
we may still revise what we feel is appropriate detail in the logs.
I removed the ChangeLog section from the tapset/DEVGIDE entirely, and
also fixed the path where examples are stored.
Diffstat (limited to 'HACKING')
-rw-r--r-- | HACKING | 30 |
1 files changed, 19 insertions, 11 deletions
@@ -6,10 +6,9 @@ the <systemtap@sources.redhat.com> mailing list. Submissions should be in an easy-to-read diff/patch form, unless this is inappropriate due to size, relevance, or fraction of novel - content. They should be accompanied by an explanation, and - ChangeLog entries. The relevant test suites should be run before - and after your changes, and regressions avoided, explained, or - corrected. + content. They should be accompanied by an explanation. The + relevant test suites should be run before and after your changes, + and regressions avoided, explained, or corrected. Established contributors may be considered for direct GIT write access. Other contributors should simply pack up the goods into a @@ -31,13 +30,22 @@ the <systemtap@sources.redhat.com> mailing list. - coding style Abide by the general formatting of the code you are modifying. The - code base generally follows the GNU standards. ChangeLog entries - are used for nontrivial changes to source or documentation files. - Some subdirectories have ChangeLog files of their own, so make sure - you find the correct ones to prepend. - - In the git commit message, make the first line an brief summary of - the patch. There is no need to transcribe the ChangeLog entries there. + code base generally follows the GNU standards in usermode code and + the Linux kernel standards in runtime code. + +- commit messages + + In the git commit message, make the first line a brief (<=50 char) + summary of the patch, and leave the second line blank. If you have + trouble coming up with a concise summary, consider whether your + patch might be better broken into smaller commits. + + For trivial changes, the summary alone may be sufficient, but most + commits should include a paragraph or two giving more details about + what the change is and why it is needed. Extra information like + bugzilla numbers and mailing-list discussion links are appreciated + as a supplement, but they are not a replacement for a real + description. - test suites |