Falco Rules Doc Comments

falcosecurity / rules

Falco rule repository

https://falcosecurity.github.io/rules/

Apache License 2.0

93 stars 68 forks source link

Falco Rules Doc Comments #150

Open leogr opened 1 year ago

leogr commented 1 year ago

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 https://github.com/falcosecurity/rules/pull/149#issuecomment-1704317483

poiana commented 10 months ago

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 commented 10 months ago

/remove-lifecycle stale

leogr commented 10 months ago

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

cc @LucaGuerra

poiana commented 7 months ago

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 commented 7 months ago

still relevant

/remove-lifecycle stale

leogr commented 7 months ago

cc @falcosecurity/falco-website-maintainers

poiana commented 4 months ago

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 commented 4 months ago

This is still a thing, IMO.

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

poiana commented 4 months ago

@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](https://github.com/falcosecurity/rules/issues/150): >This is still a thing, IMO. > >cc @falcosecurity/rules-maintainers >/help >/lifecycle stale Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

poiana commented 3 months ago

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 commented 2 months ago

/remove-lifecycle rotten /remove-lifecycle stale

@LucaGuerra @Issif May you help with this?