-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[pkg/ottl] Added 'Adding new functions/converters' guidelines #33117
[pkg/ottl] Added 'Adding new functions/converters' guidelines #33117
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this!
pkg/ottl/ottlfuncs/README.md
Outdated
## Adding New Functions/Converters | ||
|
||
Before raising a PR with a new function or converter, raise a PR to verify its acceptance. While acceptance is strongly specific to a specific use case, consider these guidelines for early assessment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Adding New Functions/Converters | |
Before raising a PR with a new function or converter, raise a PR to verify its acceptance. While acceptance is strongly specific to a specific use case, consider these guidelines for early assessment. | |
## Adding New Editors/Converters | |
Before raising a PR with a new Editor or Converter, raise an issue to describe the proposed function. While acceptance strongly depends on factors specific to each proposal, consider these guidelines for early assessment. |
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com>
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
@djaglowski I'm very interested in your opinion here, as new functions are similar to new stanza operators. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These guidelines seem reasonable to me. I think they leave room for interpretation, which is good because in some cases we may find other factors to be important.
Co-authored-by: Daniel Jaglowski <jaglows3@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @michalpristas.
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
Description:
As discussed here we should agree on some guidelines when it comes to creating proposals for new functions and converters
cc @TylerHelmuth
Link to tracking Issue: -
Testing: -
Documentation: -