From 673c3352c7e907089dc4f850a7b3692bd800fd1f Mon Sep 17 00:00:00 2001 From: Evan Bradley <11745660+evan-bradley@users.noreply.github.com> Date: Thu, 5 Dec 2024 16:01:14 -0500 Subject: [PATCH] [chore][pkg/ottl] Add additional new function guidelines This codifies a few decisions we've made recently about a few functions and will give us something to point to when considering new functions. --- pkg/ottl/CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pkg/ottl/CONTRIBUTING.md b/pkg/ottl/CONTRIBUTING.md index 0bd2d24a7a82..e5e54971b6ce 100644 --- a/pkg/ottl/CONTRIBUTING.md +++ b/pkg/ottl/CONTRIBUTING.md @@ -15,8 +15,13 @@ Your proposal likely will be accepted if: - The proposed functionality is missing, - The proposed solution significantly improves user experience and readability for very common use cases, - The proposed solution is more performant in cases where it is possible to achieve the same result with existing options. +- The proposed solution makes use of packages from the Go standard library to offer functionality possible through an existing option in a more standard or reliable manner. -It will be up for discussion if your proposal solves an issue that can be achieved in another way but does not improve user experience or performance. +It will be up for discussion if: + +- Your proposal solves an issue that can be achieved in another way but does not improve user experience or performance. +- The proposed functionality is not obviously applicable to the needs of a significant number of OTTL users. +- Your proposal extracts data into a structure with enumerable keys or values and OpenTelemetry semantic conventions do not cover the shape or values for this data. Your proposal likely won't be accepted if: