Skip to content

Conversation

mlocardpaulet
Copy link
Contributor

I updated the module life cycle document to correspond to our discussions last week.
Not sure it is all good.
Feel free to amend/comment.

@mlocardpaulet mlocardpaulet requested a review from Copilot May 26, 2025 09:44
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the module life cycle documentation to reflect recent discussions, adding requirements for external expert input and clarifying the Beta stage behavior.

  • Require external expert input and highlight modules lacking it with a caution banner
  • Refine phrasing in the Implementation and Beta sections for clarity

@rodvrees
Copy link
Contributor

Does this imply that if the beta banner is removed, there can be no added tools, or param parsing fixes?

@mlocardpaulet
Copy link
Contributor Author

Does this imply that if the beta banner is removed, there can be no added tools, or param parsing fixes?

Honestly, I am not sure how to handle this.
I would want to remove "BETA", but it is true that errors can happen when we add new tools (or even when new versions of compatible tools are released). And I don't think that we will ever be error proof. And I would like people to be aware of this.
But this does not warrant an "eternal" Beta banner. Right?

@enryH
Copy link
Member

enryH commented May 26, 2025

I would say the approval is rather for the conceptual benchmark proposed in the module, not the implementation of parameter and tool output parsing.

@mlocardpaulet mlocardpaulet added the to be discussed a decision still needs to be made label May 26, 2025
@mlocardpaulet
Copy link
Contributor Author

I guess that the beta banner and the stamp of external expert approval (although the point is more to have the discussion, I would not use "approval") are two independent things.
But I find it very difficult to clearly define when to remove the beta banner. We said that it would be at time of publication for the modules that we are currently working on. But if we get useful reviewer(s) comments, we may change modules quite a bit...

@mlocardpaulet
Copy link
Contributor Author

Maybe we should start a discussion on when to remove the beta banner? 😅

@rodvrees
Copy link
Contributor

I agree with @enryH that the BETA flag should not really reflect the implementation of param or tool parsing, since indeed there might always be errors we want to fix and eternal BETA flags are indeed not desirable.

If we want to keep the BETA banner and external expert approval banner separate, I do like the idea of the beta banner being a time-dependent thing, like you write in the docs. That there is a certain amount of time needed that is used to collect feedback and bug reports. Altough this is still a bit vague, of course

@RobbinBouwmeester RobbinBouwmeester marked this pull request as draft June 6, 2025 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
to be discussed a decision still needs to be made
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants