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.

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

chore: add post to highlight and AI settings #94

Merged
merged 2 commits into from Jun 6, 2023
Merged

chore: add post to highlight and AI settings #94

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
390812f
chore: add post to highlight and AI settings
a0m0rajab Jun 6, 2023
81fdee7
Apply suggestions from code review
bdougie Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
79 changes: 73 additions & 6 deletions docs/chrome-extension/using-the-chrome-extension.md
View file
Open in desktop
Expand Up @@ -8,22 +8,69 @@ keywords:

## Using the OpenSauced Chrome Extension

OpenSauced.ai is a must-have extension for anyone who is passionate about open-source software and wants to contribute to the community. Whether you're an experienced maintainer or just getting started, this extension makes it easy to discover, contribute to, and track open-source projects on GitHub and connect with other developers who share your interests and skills.
Have you thought about using AI to refactor a code on GitHub or even using it to write the summary of your development?
If you answered both of these questions as a yes, then you are in the right place. OpenSauced extension is a rich features chrome extension,
That's empower developers with AI tools to:

- Using AI to Write a summary of PR.
- Get AI suggestions for code reviews
- Post your work on OpenSauced website
- Get a summary of your repo (PR and Issues stats)
- Get access to OpenSauced links
- Invite a user on OpenSauced
- View a user on OpenSauced

Here are some of the features that make the OpenSauced GitHub Profile Connector so useful:

### Leverage AI generate pull request descriptions.
### Leverage AI generate pull request descriptions

This will help you to create a PR based on the configuration you have in the extension, it will enable you to create the summary based on either **Commit Messages** or **The diff between the files** or **both**, you can even set the length and the tone of the message using the same settings.

_note: This feature is not available on private repositories._

![generate pr description](../../static/gif/pr-description.gif)

### AI Settings:

You can use this settings to set the strictness and the tone of the generated AI, here is an explanation of those settings:

- **Description** length:The output length.
- **Temperature**: Is the similarity between the input text and the output, higher temperature mean more randomness, lower temperature means more strict to the input.
- **Max Input length.**
- **Description language:** right now this feature supports: English, Spanish, French, German, Italian, Portuguese, Dutch, Russian, Chinese, Korean.
- **Description tone:** The tone of the output: Exciting, Persuasive, Informative, Humorous, Formal
- **Description source:** The source of the description that our AI will use to get the output it can be the next:**Commit Messages** or **The diff between the files** or **both**

![Setting screenshot](https://user-images.githubusercontent.com/18273833/241760972-aa10eabe-3c01-4921-956a-ab85bada1575.png)

#### Changing configurations:

![ezgif-3-43e056fc1f](https://github.com/open-sauced/docs.opensauced.pizza/assets/18273833/fa19fa8e-e652-461c-8df4-6e959c9b9943)


#### Example tones:

[Example PR](https://github.com/open-sauced/insights/pull/1197), using the next options: both in the description source, 500 for output length and 3900 max input length, temperature 0.7.

**Exciting:** This PR fixes the follow call and adds a FollowUser function to the contributor-highlight-card. The code has been linted and merged from the beta branch. FollowUser function allows users to follow/unfollow contributors. Copy link and follow/unfollow options are now available in the dropdown menu.

**Persuasive:** This PR fixes the follow call and linting issues in the `ContributorHighlightCard` component. It also merges the `beta` branch into `fix-follow-check`. A new `FollowUser` function has been added to handle follow/unfollow functionality. This PR ensures a smoother user experience.

**Informative:** This PR fixes the follow call and linting issues in the `ContributorHighlightCard` component. A new function `FollowUser` has been added to handle the follow/unfollow functionality. The `useFollowUser` hook has been moved inside this function. The `FollowUser` function is now used in place of the previous follow/unfollow code block. The code has been tested and reviewed.

**Humorous:** This PR fixes the follow call and also lints the file. We've also added a new FollowUser function to make the code more readable. Now you can follow/unfollow contributors with ease. We've also merged the beta branch into fix-follow-check.

**Formal:** This PR fixes the follow call and linting issues in the `ContributorHighlightCard` component. A new function `FollowUser` has been added to handle the follow/unfollow functionality. The `useFollowUser` hook has been moved inside this function. The `FollowUser` function is now used in place of the previous follow/unfollow code block. This PR also merges the `beta` branch into `fix-follow-check`.


## Leverage AI generate for suggested code during pull request reviews

_note: This feature is not available on private repositories._
## Leverage AI generate for suggested code during pull request reviews.

![generate code suggestions](../../static/gif/code-suggestions.gif)

_note: This feature is not available on private repositories._
### View valuable insights about your GitHub profile

<!-- image -->

![GitHub Profile Insights](../../static/img/extension-popup.png)

### Invite GitHub users to join OpenSauced with a single click
Expand All @@ -37,3 +84,23 @@ _note: This feature is not available on private repositories._
### Quick Access to important OpenSauced links

![Quick Access to OpenSauced](../../static/img/extension-links.png)

### Posting highlight

You can access the post to highlight from the main popup in the extension, and when you click on it, it will automatically, get the the PR or issue title, here you can use our AI functions to get a summary of the highlight similar to the PR summary.
bdougie marked this conversation as resolved.
Show resolved Hide resolved

![location of post to highlight](https://user-images.githubusercontent.com/18273833/241761099-e7a745c8-204e-4a4d-b313-867ab99af0b2.png)

#### Successful highlight:

If you had a successful highlight it will show you a message with option to see the highlight on the OpenSauced website.
bdougie marked this conversation as resolved.
Show resolved Hide resolved

![Successful message example](https://github.com/open-sauced/docs.opensauced.pizza/assets/18273833/723ac624-e996-45f8-acdf-0d3ff08af90b)


#### Errors example:


If you faced an error with the summarization it will be printed in the text area, this is an example of it:
bdougie marked this conversation as resolved.
Show resolved Hide resolved

![Error message](https://user-images.githubusercontent.com/18273833/241762187-f6968a71-c344-495f-8eed-f1de9aff7599.gif)