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

feat: enable AI description generator on comments #285

Merged
merged 11 commits into from
Jan 12, 2024

Conversation

a0m0rajab
Copy link
Contributor

@a0m0rajab a0m0rajab commented Nov 8, 2023

Description

This is PR is a second part of #282, if we merge the one before we will have less edits here, did not feel to have one large PR.

At this PR, I just enabled the AI description generator in comments and refactored the code based on that.

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Closes #283
Closes #288

Mobile & Desktop Screenshots/Recordings

Before:
image
After:
image

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“œ README.md
  • πŸ““ docs.opensauced.pizza
  • πŸ• dev.to/opensauced
  • πŸ“• storybook
  • πŸ™… no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

@a0m0rajab
Copy link
Contributor Author

I could not check why the comment button but opened that in a new issue to make merging this easier/faster.

@nickytonline
Copy link
Member

Coming back to this issue, I wonder, do we need the AI description enabled for comments? Isn't supposed to be just for the PR description? I haven't worked with this feature really, so maybe that was something requested by users?

@a0m0rajab
Copy link
Contributor Author

I am not sure about that, but for this I felt the need for it when I update a PR and have multiple commits on it, I would like to write a comment with the latest PR changes instead of updating the PR description, which is the use use for this.

@Anush008
Copy link
Member

I am not sure about that, but for this I felt the need for it when I update a PR and have multiple commits on it, I would like to write a comment with the latest PR changes instead of updating the PR description, which is the use for this.

The description would be generated on all the changes made to the PR not only the latest. So wonder if that would be helpful when adding a follow-up description to the PR.

@a0m0rajab
Copy link
Contributor Author

You are right, this would be helpful if you have changed the logic of the PR and would like to write a follow up or even just get full summary after changes and need to write the changes happened, I have faced a similar case previously but not sure in what PR.

In that case, I had to change the initial implantation and write the changes in a comment.

Copy link
Member

@Anush008 Anush008 left a comment

Choose a reason for hiding this comment

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

Code πŸ‘πŸ‘

@Anush008 Anush008 merged commit a30380b into open-sauced:beta Jan 12, 2024
7 checks passed
github-actions bot pushed a commit that referenced this pull request Jan 12, 2024
## [1.15.0-beta.1](v1.14.3-beta.3...v1.15.0-beta.1) (2024-01-12)

### πŸ• Features

* enable AI description generator on comments ([#285](#285)) ([a30380b](a30380b))
Copy link

πŸŽ‰ This PR is included in version 1.15.0-beta.1 πŸŽ‰

The release is available on GitHub release

Your semantic-release bot πŸ“¦πŸš€

github-actions bot pushed a commit that referenced this pull request Jan 30, 2024
## [1.15.0](v1.14.2...v1.15.0) (2024-01-30)

### πŸ› Bug Fixes

* add `.gitattributes` file and normalize all the line endings ([#301](#301)) ([a6279ea](a6279ea))
* change the classname and remove extra code ([241c385](241c385))
* chunk processing in Chat component ([#289](#289)) ([f1c29ff](f1c29ff))
* elemenet to the dom if it's not added already ([c654b82](c654b82))
* Link to Usage Guide and Update README ([#298](#298)) ([ba5cef6](ba5cef6))

### πŸ• Features

* enable AI description generator on comments ([#285](#285)) ([a30380b](a30380b))
* Upgrade to v2 API ([693d459](693d459))
Copy link

πŸŽ‰ This PR is included in version 1.15.0 πŸŽ‰

The release is available on GitHub release

Your semantic-release bot πŸ“¦πŸš€

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants