Bug 8182 - Add descriptions for most rules
Summary: Add descriptions for most rules
Status: NEW
Alias: None
Product: Spamassassin
Classification: Unclassified
Component: Rules (show other bugs)
Version: SVN Trunk (Latest Devel Version)
Hardware: PC Mac OS X
: P2 normal
Target Milestone: Undefined
Assignee: SpamAssassin Developer Mailing List
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-08-17 01:56 UTC by jsoref
Modified: 2023-08-17 01:56 UTC (History)
0 users


Attachment Type Modified Status Actions Submitter/CLA Status
assign descriptions to most rules that don't have descriptions text/plain None jsoref@gmail.com [NoCLA]
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description jsoref 2023-08-17 01:56:27 UTC 
Created attachment 5911 [details]
assign descriptions to most rules that don't have descriptions

A number of rules don't have descriptions, I've tried to write up descriptions for most of them.

In a handful of cases I've added comments identifying when a rule was introduced/likely relevant because I had to do that work to figure out what the rule was for, and that should hopefully help others in the future.

For a couple of rules where it seems like the rule authors were uncertain, I've included a request for people to send feedback about rules.

Note that I constructed these commits as a series which you can see here: https://github.com/jsoref/spamassassin/compare/trunk...describe as such, one of the changes (describe TVD_IP_HEX) relies on the patch in attachment 5909 [details] to bug 8180.

----

The most important change for us is adding a description to HTTPS_HTTP_MISMATCH because that triggers regularly (especially because SENDGRID_REDIR triggers for email we send) and the default message `BODY: No description available.` is not helpful.

Note that while I'm proposing this change, I'm not changing any scores--just giving people who read the report about the email a slightly less confusing experience. Here's the scoring for an email that I triggered to myself (without these changes applied, although I did have to tune the scoring so the messages wouldn't be rejected by our exim daemon):

 Content analysis details:   (4.2 points, 5.0 required)

  pts rule name              description
 ---- ---------------------- --------------------------------------------------
  1.1 URIBL_GREY             Contains an URL listed in the URIBL greylist
                             [URIs: sendgrid.net]
  1.5 SPF_HELO_NONE          SPF: HELO does not publish an SPF Record
 -1.0 SPF_PASS               SPF: sender matches SPF record
  0.8 HTML_FONT_LOW_CONTRAST BODY: HTML font color similar or
                             identical to background
  1.5 HTTPS_HTTP_MISMATCH    BODY: No description available.
  0.3 HTML_MESSAGE           BODY: HTML included in message