Rule Sandboxes

(Note: this is now documentation, meaning that RulesProjectPlan et al have become historical planning docs. we planned this bit at RulesProjSandboxes.)

Every committer has a 'sandbox' area in the rules source tree ('rulesrc'). This is an area for rules under development.

...

2. Create as many files in this directory as I wish, containing as many rules as I wish, named "NN_anything.cf" (where "NN" is 2 digits).

    vi rulesrc/sandbox/whatever/NN_anything.cf

Each rule should start with a T_ prefix. (This lets the engine know that it's a rule under test, so it gets a minimal score; it's also easier to tell them apart from the "core" ruleset in the nightly mass-checks.)

3. Check those files into SVN:

...

4. Watch as the preflight mass-checker starts checking them immediately at the PreflightBuildBot, http://buildbot.SpamAssassin.org/preflight/ .

...

6. Wait until the mass-check results are in, and look at the results at the RuleQaApp, http://buildbot.spamassassin.org/ruleqa/ .

...

(To expand – those last two steps require some thinking about how we're to do the promotion criteria, which is as yet undone.)

Moving Rules To Core

Once rules are deemed 'good enough', according to whatever the promotion criteria are, they can be promoted from the sandbox into core. TODO. We haven't quite solidified the promotion criteria for rules yet... see RulesProjPromotion for ongoing discussion.

(Note: this is documentation; if you want to read the historical planning docs, see RulesProjectPlan and RulesProjSandboxes.)