diff options
author | Greg Troxel <gdt@ir.bbn.com> | 2010-11-03 07:37:23 -0400 |
---|---|---|
committer | Greg Troxel <gdt@ir.bbn.com> | 2010-11-03 07:37:23 -0400 |
commit | 5195e17f8b49dc720252526a21afd7840240137b (patch) | |
tree | e0ab06a35a8ddeede025ecef495f947f350cd7e7 | |
parent | a8e474a598ed01591fd3814eee5f5b6a909e4f59 (diff) |
infrastructure: Express preference for published git repos
* HACKING: Express notion that a published git repository is
preferred. Fold request for commit message into patch section.
Express desire for comments in code explaining correctness of
post-commit state, and for commit message to explain correctness of
the change.
-rw-r--r-- | HACKING | 20 |
1 files changed, 15 insertions, 5 deletions
@@ -247,6 +247,14 @@ library libzebra and the included daemons should always be built and installed together. +GIT COMMIT SUBSMISSION + +The preferred method for changes is to provide git commits via a +publically-accessible git repository. + +All content guidelines in PATCH SUBMISSION apply. + + PATCH SUBMISSION * Send a clean diff against the 'master' branch of the quagga.git @@ -256,14 +264,16 @@ PATCH SUBMISSION git diff -up mybranch..remotes/quagga.net/master - Or by using git-format-patch. + It is preferable to use git format-patch, and even more preferred to + publish a git repostory. -* Not doing so is a definite hindrance to patch application. + If not using git format-patch, Include the commit message in the email. -* Include NEWS entries as appropriate. +* After a commit, code should have comments explaining to the reviewer + why it is correct, without reference to history. The commit message + should explain why the change is correct. -* Please, please include an appropriate commit message with any emailed - patches. Doing so makes it easier to review a patch, and apply it. +* Include NEWS entries as appropriate. * Include only one semantic change or group of changes per patch. |