Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 3.04 KB

README.md

File metadata and controls

70 lines (51 loc) · 3.04 KB
Raw

GitHub Issue Creator

A Chrome plugin to create GitHub issues with selected text from a web page and the web page address.

Features

  • Creates GitHub issues with selected text from any web page
  • Automatically includes the web page address in the issue

Installation

For the plugin to work, you'll need a GitHub access token with the repo scope. To generate one, follow these steps:

  • Go to GitHub's settings page: https://github.com/settings/tokens
  • Click on "Generate new token"
  • Give your token a name, select the repo scope, and click "Generate token"
  1. Clone this repository.
git clone https://github.com/mrtrvl/references.git
  1. Install the plugin in Chrome:
  • Open Chrome and go to chrome://extensions
  • Enable Developer mode in the top-right corner
  • Click Load unpacked and select the plugin directory you created earlier
  • After installing the plugin, right click on the plugin icon in the Chrome toolbar, and then click on the Options to open the options page.
  • On the options page, enter your GitHub access token and repository information in the respective input fields. The repository should be in the format yourusername/repositoryname.
  • You can add multiple repositories
  • Click the Save button to save your settings.

Usage

  • Navigate to any web page.
  • Select the text you want to include in the GitHub issue.
  • Click on the plugin icon in the Chrome toolbar.
  • Add Issue Title text (if not provided, then selected text will be as Issue Title)
  • Choose repository from the repositories list (last used will be default next time)
  • Click the "Create Issue" button in the popup.
  • An issue will be created in the specified GitHub repository with the selected text and the web page address.
  • If the action is successful, you will see an alert saying, "GitHub issue created successfully!" Otherwise, you will see an error message.

Icons used

Star icons created by Smashicons - Flaticon

License

MIT License

Copyright (c) [Martti Raavel] [2023]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.