Skip to content

A Chrome Extension to add the Particular saved replies to GitHub

Notifications You must be signed in to change notification settings

awright18/SharedSavedReplies

Repository files navigation

What is Shared Saved Replies

Shared Saved Replies is a browser extension that allows teams to create saved replies for use on GitHub.com. It will populate the saved replies list when adding a new comment to an issue or pull request in a GitHub repository. For teams continuously evolving the structure and requirements of their saved replies templates this extension will keep the saved replies up to date, by updating and caching them on a schedule set up the user.

Saved Replies Example

Where do I get it?

For Chrome or Edge users:

For Firefox users:

How do I use it?

Create saved reply templates

To create a saved reply template create a mark down file in a GitHub repository.

  1. Add a saved reply name in an h2.

  2. Add a markdown code block immediately after the H2 saved reply name.

  3. commit the file to repostiory and make sure its a .md file accessible at GitHub.com

    • This file can be used with private organizations, the people using the template will need to have permssions to the org or repo in able to be able to share the saved replies.

Instructions for use and multiple saved replies can be added in the same file. The extension is looking for the H2 (##) followed by the markdown code section pattern in a .md file.

Example Saved Reply Temple

# our Teams Saved Replies

These replies are to be used by our team to facilitate consistent communication. 

## Work Started
```markdown 


## 🚀 Work Started 

### 📝 High level plan



### ⏲ Update schedule 


```

## Work Completed
```markdown
## 🎉Work Complete


```

Using the extension

Install and configure the extension

  1. Install the Shared Saved Replies chrome extension or the firefox addon
  2. Pin the extension.
  3. Click on the pinned extension icon.
  4. Click the plus button.

Popup Screen

  1. For "Saved Replies Url": Enter the GitHub url of the the saved replies .md file that was created prevoulsy. (This should not be the raw url).
  2. For "Name", Provide a unique name for the configuration.
  3. For "Use with all GitHub repositories" If the saved replies should be used across all of GitHub then switch the toggle to on. If not switch it off and enter the name of a github organization or user that you want to limit the replies to in "Limit to this GitHub organization or user"
  4. For "Applies to Issues" If the saved replies should show for issues switch the toggle on, if they shouldn't be shown for issues switch the toggle to off.
  5. For "Applies to Pull Request" If the saved replies should show for pull requests switch the toggle on, if they shouldn't be shown for pull requests switch the toggle to off.
  6. Set the refresh rate of how often the saved replies will be updated. The default is every 30 minutes. (This process only takes a few hundred milliseconds to perform.)
  7. Click save.

Add Saved Replies Screen

Use the saved replies

  1. Navigate to either an issue or pull request and clicked the "saved replies" icon on the new comment menu and see your saved replies appear.

Click on Save Replies Icon

About

A Chrome Extension to add the Particular saved replies to GitHub

Resources

Stars

Watchers

Forks

Packages

No packages published