https://github.com/eschao/mygit-extension

A Chrome/Firefox extension for GitHub website
https://github.com/eschao/mygit-extension

chrome chrome-extension extension firefox firefox-addon firefox-extension github issue javascript

Last synced: 6 days ago
JSON representation

A Chrome/Firefox extension for GitHub website

• Host: GitHub
• URL: https://github.com/eschao/mygit-extension
• Owner: eschao
• License: apache-2.0
• Created: 2017-04-30T14:14:08.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-22T07:41:46.000Z (about 7 years ago)
• Last Synced: 2024-11-05T11:37:19.851Z (about 2 months ago)
• Topics: chrome, chrome-extension, extension, firefox, firefox-addon, firefox-extension, github, issue, javascript
• Language: JavaScript
• Homepage:
• Size: 379 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        






## MyGit-Extension

> A Chrome/Firefox extension for GitHub

- [Introduction](#introduction)

  - [Export Issues As CSV](#1-export-issues-as-csv)

  - [Save Issue Filter](#2-save-issue-filter)

  - [Favorite Repository](#3-favorite-repository)

  - [More Colors For Label Creation](#4-more-colors-for-label-creation)

  - [Issue Preview](#5-issue-preview)

- [Installation](#installation)

- [Usage](#usage)

- [License](#license)

## Introduction

**MyGit-Extension** aims to provide extra functions for convenient GitHub user through injecting html/javascript codes into GitHub website. 

The following functions are planned to provide:

#### 1. Export Issues As CSV

 

   


   

   

   

   Injects an **```Export```** button next to **```Milestones```** in issue page. You can launch the **```Export```** wizard dialog by it and customize the the below settings to generate CSV format file:

   - Enable/disable exporting issue fields

   - Adjust issue fields order

   - Customize CSV delimiter

   - Enable/disable expanding issue labels

   

#### 2. Save Issue Filter

   

   


   

   

   

   Injects a **Save** button in issue filter input box. You can

   - Save filter with a customized name

   - Overwrite an existing filter

   - Get them in **Filters** dropdown list

   - Remove them from the **Filters** dropdown list

   

#### 3. Favorite Repository

 

   


   

   

   

   Injects a **Favorite Repos** in GitHub top banner. You can save the current repository as favorite one or quickly jump to a favorite repository by it.

   

#### 4. More Colors For Label Creation (Deprecated)

 

   


   

   

   

   Injects a rich color list for label creation and edit.

#### 5. Issue Preview

 

   


   

   

  

   You can preview a issue though moving mouse over a issue link in **Issue** and **Pull Request** pages. 

   * **What can you see in preview**

     - Issue title/number

     - Issue state/creator

     - Issue milestone

     - Issue assignees

     - Issue labels

     - Issue description

   * **What's limitation for preview**

     - Only can preview issue link in **Issue** and **Pull Request** pages

     - Can't show issue comments 

     - Issue description is shown with original format, for example: markdown original format

   

## Installation


  * Install from Chrome/Firefox store

  

    - For **Chrome**: [Chrome Web Stroe](https://chrome.google.com/webstore/detail/mygit/oaiohmmoefnkfdbjjkjnconhnhpiigel?hl=en)

    - For **Firefox**: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mygit)

    

  * Install from [release](https://github.com/eschao/MyGit-Extension/releases)

  

    - Download the latest relase from release page

    - For **Chrome**: Open chrome extension page by clicking **```Settings -> Extensions```**, drag the downloaded crx file into this page, Chrome will ask you and click **```Yes```** to install.

 

## Usage

**MyGit** extension supports public GitHub and GitHub Enterprise. Due to the limitation of browser extension, there is only one GitHub enterprise -**IBM**- to be available now. If you need to support a new one, please tell me its name and uri to add.

The extension only needs **```repo```** and **```user:email```** scopse. More details about GitHub scopes, please see **[here](https://developer.github.com/enterprise/2.8/v3/oauth/#scopes)**

  


  

  


  * **Sign In Public GitHub**

  

    Click **```Sign In GitHub```**, it will open GitHub authroization page into a new browser tab and ask you grant neccessary scopes for extenstion to access your repository.

  

  * **Sign In GitHub Enterprise**

  

    Before signning in GitHub enterpise, you need to follow the below steps to generate a **[```Personal access tokens```](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)** 

    - Login GitHub and goto **```Settings```** page

    - Click **```Personal access tokens```** to open it

    - Click **```Generate new token```** 

    - Input **```Token description```** as you like, for example: MyGit Extension

    - Select the below **```Scopes```**

      * All scopes of **```repo```**

      * Scope: **```user:email```**

    - Click **```Generate token```** button at the bottom of the page

    

    And now, you have an access token for MyGit extension, copy and paste it into token input box, click **```Sign In GitHub Enterprise```** to login.

## License

This project is licensed under the Apache License Version 2.0.