coreruleset / documentation

CRS Documentation
https://coreruleset.org/docs/
3 stars 20 forks source link

feat(docs): Expose tooling for rule developers #73

Open lifeforms opened 1 year ago

lifeforms commented 1 year ago

Motivation

We need more input from new contributors. Currently, we are relying more and more on a lot of internal and external tools to write our rules. Not everybody may know them, while they are so helpful to create better rules.

I think we should have something like a "Great tools for rule writers" page to bring the rule writing practices from the 2000s to the 2020s.

And maybe even end with a full-fledged "rule writing walkthrough" that strings all the tools together to create a sample rule (could be moved to a separate issue if we want to do that).

Proposed solution

At least, we could make a list of useful tools and links to them.

For example:

At best we could have the list, and also create a 'walkthrough' for creating a rule that goes from:

Alternatives

Karel always just does a web search for 'execute postgres online'. But there's a bigger chance that people might give up.

Additional context

N/A

fzipi commented 1 year ago

Shall we move this one to https://github.com/coreruleset/documentation ?

dune73 commented 1 year ago

It's a great proposal btw.