Skip to content
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

Merged
merged 13 commits into from
Jun 14, 2024

Conversation

michalpristas
Copy link
Contributor

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: -

Copy link
Contributor

@evan-bradley evan-bradley left a 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!

Comment on lines 1312 to 1314
## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 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.

pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
@TylerHelmuth TylerHelmuth requested a review from djaglowski May 28, 2024 21:40
@TylerHelmuth
Copy link
Member

@djaglowski I'm very interested in your opinion here, as new functions are similar to new stanza operators.

Copy link
Member

@djaglowski djaglowski left a 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.

pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
@TylerHelmuth TylerHelmuth added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jun 12, 2024
Copy link
Contributor

@evan-bradley evan-bradley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @michalpristas.

pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
@evan-bradley evan-bradley merged commit 69e9141 into open-telemetry:main Jun 14, 2024
138 checks passed
@github-actions github-actions bot added this to the next release milestone Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg/ottl Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants