Falco Rules Doc Comments

[leogr]

Motivation

The issues I found with comments are due to practical reasons. In particular:

• There should be no empty lines between the comments and the referred item
  • This will avoid ambiguities.
  • I guess I mostly fixed that with this PR.
• There's no standard item's comment structure
  • I would love to define a simple Rule Doc convention (i.e., something similar to Go Doc Comments, but simpler)
• There's no clear way to distinguish sections from item's comment

Feature

Implement a simple Rules Doc Comments guideline and add it to the rules style guide.

Alternatives

Just rely on an existing convention, if any, or do nothing. However they don't look like compelling alternatives.

Additional context

See #149 (comment)

[poiana]

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

[leogr]

/remove-lifecycle stale

[leogr]

@incertum do you think this is still valuable? wdyt?

cc @LucaGuerra

[poiana]

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

[incertum]

still relevant

/remove-lifecycle stale

[leogr]

cc @falcosecurity/falco-website-maintainers

[poiana]

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

[leogr]

This is still a thing, IMO.

cc @falcosecurity/rules-maintainers
/help
/lifecycle stale

[poiana]

@leogr:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

This is still a thing, IMO.

cc @falcosecurity/rules-maintainers
/help
/lifecycle stale

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[poiana]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh with /remove-lifecycle rotten.

Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle rotten

[leogr]

/remove-lifecycle rotten
/remove-lifecycle stale

@LucaGuerra @Issif May you help with this?

[poiana]

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

[leogr]

/remove-lifecycle stale