Skip to content

Adds AI feedback support for changelog markdown editors #4479

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 5, 2025
Merged

Adds AI feedback support for changelog markdown editors #4479

merged 2 commits into from
Aug 5, 2025

Conversation

sergeibbb
Copy link
Member

@sergeibbb sergeibbb commented Jul 8, 2025 •
edited
Loading

Description

This is a follow-up of #4449

Enables the use of helpful/unhelpful AI feedback buttons in untitled markdown editors generated by the changelog command.

Tracks feedback context for these documents, updates relevant context keys.

Checklist

  • I have followed the guidelines in the Contributing document
  • My changes follow the coding style of this project
  • My changes build without any errors or warnings
  • My changes have been formatted and linted
  • My changes include any required corresponding changes to the documentation (including CHANGELOG.md and README.md)
  • My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
  • My changes have a descriptive commit message with a short title, including a Fixes $XXX - or Closes #XXX - prefix to auto-close the issue that your PR addresses

@sergeibbb sergeibbb mentioned this pull request Jul 8, 2025
Merged
7 tasks
@sergeibbb
Copy link
Member Author

sergeibbb commented Jul 8, 2025 •
edited
Loading

Hi @eamodio

This PR is the implementation for Changelogs in a similar manner how it's been done for markdown previews.

Please let me know if you think that something needs to be improved here.

Also it has a follow-up where I suggest to wrap static values to a disposable provider.

@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 4437459 to 8b7c748 Compare July 9, 2025 13:48
@sergeibbb sergeibbb marked this pull request as ready for review July 9, 2025 13:53
@sergeibbb sergeibbb requested a review from eamodio July 9, 2025 13:53
@sergeibbb sergeibbb self-assigned this Jul 9, 2025
@sergeibbb sergeibbb requested a review from axosoft-ramint July 9, 2025 13:53
@sergeibbb sergeibbb linked an issue Jul 9, 2025 that may be closed by this pull request
Capture sentiment feedback about AI feature effectiveness #4449
Closed
4 tasks
sergeibbb added a commit that referenced this pull request Jul 9, 2025
@sergeibbb
Adds AI feedback support for changelog markdown editors
127e17f 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
sergeibbb added a commit that referenced this pull request Jul 9, 2025
@sergeibbb
Updates CHANGELOG:
5233993 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 8b7c748 to 5233993 Compare July 9, 2025 14:20
@sergeibbb sergeibbb added this to the 17.4 milestone Jul 10, 2025
sergeibbb added a commit that referenced this pull request Jul 14, 2025
@sergeibbb
Adds AI feedback support for changelog markdown editors
816ab74 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 5233993 to 28c7ed5 Compare July 14, 2025 09:20
sergeibbb added a commit that referenced this pull request Jul 14, 2025
@sergeibbb
Updates CHANGELOG:
28c7ed5 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
sergeibbb added a commit that referenced this pull request Jul 28, 2025
@sergeibbb
Adds AI feedback support for changelog markdown editors
4bec692 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
sergeibbb added a commit that referenced this pull request Jul 28, 2025
@sergeibbb
Updates CHANGELOG:
7ac7c33 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 28c7ed5 to 60b3f8f Compare July 28, 2025 16:39
sergeibbb added a commit that referenced this pull request Jul 28, 2025
@sergeibbb
Adds AI feedback support for changelog markdown editors
c58ec7b 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
sergeibbb added a commit that referenced this pull request Jul 28, 2025
@sergeibbb
Updates CHANGELOG:
60b3f8f 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
sergeibbb added a commit that referenced this pull request Jul 28, 2025
@sergeibbb
Updates CHANGELOG:
91f9b4a 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 60b3f8f to 91f9b4a Compare July 28, 2025 17:15
@sergeibbb sergeibbb mentioned this pull request Jul 31, 2025
Merged
7 tasks
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from eee474b to 91f9b4a Compare July 31, 2025 12:26
sergeibbb added a commit that referenced this pull request Jul 31, 2025
@sergeibbb
Adds AI feedback support for changelog markdown editors
b2151fb 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
sergeibbb added a commit that referenced this pull request Jul 31, 2025
@sergeibbb
Updates CHANGELOG:
13055df 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 91f9b4a to 13055df Compare July 31, 2025 12:41
axosoft-ramint
axosoft-ramint reviewed Aug 4, 2025
View reviewed changes
src/commands/generateChangelog.ts
@@ -98,12 +132,22 @@ export async function generateChangelogAndOpenMarkdownDocument(
if (result === 'cancelled') return;

const { range, changes: { length: count } = [] } = await changes.value;
const feedbackContext = result && getAIResultContext(result);
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this always guaranteed to hit the case uri?.scheme === Schemes.GitLensAIMarkdown? Otherwise on a quick read it looks like it would result in a getChangelogFeedbackContext which wouldn't exist yet (I must be missing something).

Copy link
Member Author

Choose a reason for hiding this comment

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

@axosoft-ramint
It is rather guaranteed that changelog's scheme is not GitLensAIMarkdown. It's "untitled".

  • getAIResultContext is an util function creates an object assigned to feedbackContext.
  • const document = await workspace.openTextDocument creates a document with untitled scheme.
  • then setChangelogFeedbackContext stores the context.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks

sergeibbb added a commit that referenced this pull request Aug 5, 2025
@sergeibbb
Adds AI feedback support for changelog markdown editors
489bb32 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
sergeibbb added a commit that referenced this pull request Aug 5, 2025
@sergeibbb
Updates CHANGELOG:
5fd6a0f 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 13055df to 5fd6a0f Compare August 5, 2025 15:45
@sergeibbb
Adds AI feedback support for changelog markdown editors
834197d 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
@sergeibbb
Updates CHANGELOG:
621283b 
mentions the new  feedback buttons to AI-generated Changelog feature
(#4449, #4479)
@sergeibbb sergeibbb force-pushed the 4449-feedback-on-changelog branch from 5fd6a0f to 621283b Compare August 5, 2025 16:09
@sergeibbb sergeibbb merged commit 16fd8c3 into main Aug 5, 2025
3 checks passed
sergeibbb added a commit that referenced this pull request Aug 5, 2025
@sergeibbb
Adds AI feedback support for changelog markdown editors
e3b3ecd 
Enables the use of helpful/unhelpful AI feedback buttons in untitled
markdown editors generated by the changelog command. Tracks feedback
context for these documents, updates relevant context keys, and ensures
telemetry compatibility. Also improves feedback instructions in
generated changelogs to encourage user interaction. Updates telemetry
and menu configuration to support this new AI feedback capability for
changelog editors.
(#4449, #4479)
@sergeibbb sergeibbb deleted the 4449-feedback-on-changelog branch August 5, 2025 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@axosoft-ramint axosoft-ramint axosoft-ramint approved these changes

@eamodio eamodio Awaiting requested review from eamodio

Assignees

@sergeibbb sergeibbb

Labels
None yet
Projects
None yet
Milestone
17.4
Development

Successfully merging this pull request may close these issues.

Capture sentiment feedback about AI feature effectiveness
2 participants
@sergeibbb @axosoft-ramint