Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Feature] GitHub Search #15

Merged
merged 8 commits into from
Aug 15, 2022
Merged

Conversation

samad-yar-khan
Copy link
Collaborator

@samad-yar-khan samad-yar-khan commented Jul 21, 2022

Issue(s)

closes #12

Acceptance Criteria fulfillment

  • Enable user to trigger a search modal using /github search.
  • Enable user to enter search queries and fetch relevant results.
  • User Should be able to view and select the relevant search results in a another search view modal.
  • Users should be able to send selected search result in the desired room.
  • Add documentation to the wiki for the GitHub search mechanism and user-flow
  • Handle non authenticated users edge cases. (GitHub Search API requires OAuth Token)

Proposed changes (including videos or screenshots)

  • Added Documentation for GitHub Search Feature
  • Added GitHub Search Modal which allows users to search repository issues and pull request based on different filters.
2022-07-21.21-56-26.mp4
  • Added Result Sharing functionality. Enabled user to send selected Pull Request or Issue to current room by clicking on Share. Users can visit the issue/pull request on GitHub by clicking on GitHub button.
2022-07-21.22-04-15.mp4
  • Added View Changes button, which will be added to all Pull Request Results. Users can click on View Changes and see more details of the PR, including code changes. ( This can be one of the major painkillers. This will be upgraded to a code editor with indentation depending on the fuselage team PR )
2022-07-21.22-05-38.mp4

Further comments

  • Some of the features like reviewing code changes of a PR has been integrated with this Pull Request Change Result to improve collaboration.

@samad-yar-khan
Copy link
Collaborator Author

@RonLek Can you please take a look at this PR and suggest any changes.

@RonLek
Copy link
Collaborator

RonLek commented Jul 22, 2022

Thanks @samad-yar-khan for your PR. Can we also copy the link to clipboard when the user clicks Share. Do you think that would be possible with the Apps-Engine?

@RonLek RonLek added the enhancement New feature or request label Jul 22, 2022
@samad-yar-khan
Copy link
Collaborator Author

Thanks @samad-yar-khan for your PR. Can we also copy the link to clipboard when the user clicks Share. Do you think that would be possible with the Apps-Engine?

@RonLek We can right click on the GitHub Button and copy the link, the GitHub button is linked to that URL. I will see if its possible to add a Copy To Clipboard type of option, that would be a good feature ! But that would ultimately depend on the fuselage implementation, I will take a look :)

@Sing-Li
Copy link
Member

Sing-Li commented Jul 31, 2022

Excellent! (I have been skeptical in the recent past about the value of this feature without the ability to review code in detail)

One urgent suggestion is -- in the case of "Share" .....

  1. allow multiple "Share" from one search - by toggle-highlighting the SHARE buttons (turning blue/highlighted) and adding a SEND ALL SHARED button at the bottom

  2. add a "summary message" free text at the top; it defaults to a description of the search parameters you applied --- but allows user override and editing

Then when "SEND ALL SHARED" is clicked, the "summary message" is appended with each of the highlighted issues and inserted as a larger message into the conversation.

This will "match" a typical usage of this feature significantly better and avoid having to do /github search multiple times in the workflow.

@samad-yar-khan
Copy link
Collaborator Author

@Sing-Li @RonLek I have added the multi-share feature mentioned in the comment. Have a look :)

2022-08-12.21-21-52.mp4

Excellent! (I have been skeptical in the recent past about the value of this feature without the ability to review code in detail)

One urgent suggestion is -- in the case of "Share" .....

  1. allow multiple "Share" from one search - by toggle-highlighting the SHARE buttons (turning blue/highlighted) and adding a SEND ALL SHARED button at the bottom
  2. add a "summary message" free text at the top; it defaults to a description of the search parameters you applied --- but allows user override and editing

Then when "SEND ALL SHARED" is clicked, the "summary message" is appended with each of the highlighted issues and inserted as a larger message into the conversation.

This will "match" a typical usage of this feature significantly better and avoid having to do /github search multiple times in the workflow.

Copy link
Collaborator

@RonLek RonLek left a comment

Choose a reason for hiding this comment

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

Great work @samad-yar-khan . LGTM.

@RonLek RonLek merged commit 206fb3d into RocketChat:main Aug 15, 2022
@samad-yar-khan samad-yar-khan mentioned this pull request Oct 14, 2022
4 tasks
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] GitHub Search integration enabling users to search for Issues and Pull Request
3 participants