Proposal: Modularize PR Descriptions for Relevance

[gounthar]

What feature do you want to see added?

Background

As highlighted by @MarkEWaite in PR #108, our current PR descriptions can be overwhelmingly detailed. While such detail is beneficial when making significant transitions (e.g., from JDK 8/Jenkins 1.x to JDK 17/Jenkins 2.492.x), it becomes excessive for minor updates, like the transition from JDK 17/Jenkins 2.479.x to JDK 17/Jenkins 2.492.x.

Proposal

To address this, we suggest adopting a modular approach for PR descriptions, where only the relevant changes are included:

1. Identify Sub-Recipes: Determine the specific sub-recipes or components that have changed in the update.
2. Dynamic Description Generation: Automatically generate PR descriptions that focus only on the paragraphs directly related to these changes, omitting non-essential information.
3. Template Customization: Develop templates that can be modularly adjusted based on the components affected in the update.

Benefits

• Clarity: Focused descriptions enhance readability and comprehension, helping reviewers quickly identify critical changes.
• Efficiency: Saves time for both creators and reviewers by reducing unnecessary information.
• Relevance: Ensures that the PR description remains pertinent to the actual changes made, fostering better decision-making.

Next Steps

• Develop a mechanism for identifying relevant sub-recipes in each update.
• Implement a system for generating dynamic, modular PR descriptions.
• Test the approach and refine based on feedback from collaborators.

Upstream changes

No response

Are you interested in contributing this feature?

No response