Page History

...

(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.

...

The main thing is that it's a place to put rules that match the ruleset's publishing criteria (whatever they may be) without putting them in the SpamAssassin core.

Getting Started

1. Create a new sandbox in rulesrc/sandbox (e.g. rulesrc/sandbox/duncf):
   

    mkdir rulesrc/sandbox/whatever
    svn add rulesrc/sandbox/whatever

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)

3. Check those files into SVN:

    svn add rulesrc/sandbox/whatever/NN_anything.cf

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

5. (Optionally) wait for a nightly mass-check.

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

7. Tweak until I'm satisfied with my rule.

8. ???

9. Profit!

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