]> git.ipfire.org Git - thirdparty/apache/httpd.git/commitdiff
Further refine CHANGES description, to prod Claude into
authorJoe Orton <jorton@apache.org>
Fri, 17 Jul 2026 10:19:26 +0000 (10:19 +0000)
committerJoe Orton <jorton@apache.org>
Fri, 17 Jul 2026 10:19:26 +0000 (10:19 +0000)
producing more useful output.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1936251 13f79535-47bb-0310-9956-ffa450edef68

README.CHANGES

index 9b1c972b22197496ade7c43962e9317493b4576e..bb6de8747a4ffff97af89876459fad1fb280434a 100644 (file)
@@ -22,11 +22,16 @@ with the .txt suffix, using the following template:
 Changes to server/*.[ch] use a "core:" prefix rather than "mod_foo:".
 
 The description should be as concise as possible, a maximum of three
-lines but ideally one or two. The credit for the change goes to the
-original patch author(s) and will usually match the "Submitted by: "
-tag in the commit message. For current committers, use only the
-name and not the e-mail address in the credit. Replace "@" in any
-e-mail addresses with a space to prevent address harvesting.
+lines but ideally one or two; describe the user-visible effect of the
+change rather than simply describing how the code was fixed. New
+modules or config directives do NOT need to be explained in detail,
+that is covered in the documentation.
+
+The credit for the change goes to the original patch author(s) and
+will usually match the "Submitted by: " tag in the commit message. For
+current committers, use only the name and not the e-mail address in
+the credit. Replace "@" in any e-mail addresses with a space to
+prevent address harvesting.
 
 Use a Bugzilla bug number in the PR reference.