Browse Source

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.
Greg Troxel 9 years ago
1 changed files with 15 additions and 5 deletions
  1. 15 5

+ 15 - 5

@@ -247,6 +247,14 @@ library libzebra and the included daemons should always be built and
 installed together.
+The preferred method for changes is to provide git commits via a
+publically-accessible git repository.
+All content guidelines in PATCH SUBMISSION apply.
 * Send a clean diff against the 'master' branch of the quagga.git
@@ -256,14 +264,16 @@ PATCH SUBMISSION
     git diff -up mybranch..remotes/
-  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.