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

Enhancement: Improve Auto-Summarization for Highlights (Pull Request context) #2657

Open
1 of 2 tasks
babblebey opened this issue Feb 14, 2024 · 1 comment
Open
1 of 2 tasks

Comments

@babblebey
Copy link
Contributor

Type of feature

🍕 Feature

Current behavior

The current auto-summarization feature in the highlight creation process sometimes produces summaries that are not optimal in the context of "pull requests", especially when the commit titles (acknowledging it looks up commit message for generating summaries) are not descriptive enough.

For example, sentences like "It also merges the beta branch into the refactor/typography-components-in-design-system branch." resulted from this.... see screenshot below for a summary that was generated for the stated pull request.

PR: #1438

image

build: Add `@tailwindcss/typography` plugin, refactor typography components in design system

This PR adds the `@tailwindcss/typography` plugin to the build process and refactors the typography components in the design system. It also merges the `beta` branch into the `refactor/typography-components-in-design-system` branch.

Suggested solution

Prioritize the use of the pull request description for auto-summarization. I think Pull request descriptions typically provide a more comprehensive overview of the changes and goals of the pull request, which can lead to more informative and cleaner summaries.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
Copy link
Contributor

Thanks for the issue, our team will look into it as soon as possible! If you would like to work on this issue, please wait for us to decide if it's ready. The issue will be ready to work on once we remove the "needs triage" label.

To claim an issue that does not have the "needs triage" label, please leave a comment that says ".take". If you have any questions, please reach out to us on Discord or follow up on the issue itself.

For full info on how to contribute, please check out our contributors guide.

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

No branches or pull requests

1 participant