Giter VIP home page Giter VIP logo

kowndinya2000 / gitq Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 50 KB

GitHub has nearly 44 million public repositories out of 190 million repositories. GitHub currently has a 54 million developer network. If someone wants to look out for good repositories, it will be quite difficult to navigate through repositories, especially for novice programmers. So, what did we do? We made an attempt to help the novice developers better understand the repository about source code and maintenance. So, what is GitQ? GitQ is a browser plugin, when added to a browser GitQ shows visual badges for repositories on Github. GitQ augments GitHub with badges that deliver visual cues quantifying the project’s architecture and maintenance. It also provides additional project information w.r.t metric scores. With GitQ, we wish to improve developers’ experience while using GitHub; help them identify the right repository for re-use or contribution.

Home Page: https://youtu.be/c0yohmIat3A

JavaScript 77.74% Python 22.09% Shell 0.17%
badge-generator badges github maintenance-metrics source-code-metrics visual-cue

gitq's Introduction

GitQ [Master Version of GitQ works. Services are up!]

What is GitQ?

GitQ has a Chrome plugin to augment GitHub with badges that deliver visual cues quantifying the project’s architecture and maintenance.

Features of GitQ Plugins:

  1. Analyzes the repository with respect to 6 source code metrics and 4 maintenance metrics
  2. Metrics and their scores are shown as badges
  3. Insight icons are displayed at the end to provide additional information about each maintenance metric

Uses of GitQ:

GitQ is aimed to effectively improve developers' experience while using Github and assist them to identify the right repository to fork and use or to contribute to.

Overview diagram of GitQ:

approach

Snapshot of GitQ Assessment Report:

assesment-report

What's inside GitQ Repository:

In the GitQ folder,
"background.js" file contains all the source code related to analyzing repository and displaying badges. "manifest.json" file includes the url that triggers start of GitQ.

Steps to install GitQ's Plugin:

  1. Download the repository on your local machine.
  2. Unzip the folder and extract it to a location of your choice on your PC.
  3. Now, open Google Chrome and Go to Settings
  4. Select Extensions or navigate to chrome://extensions
  5. Turn on Developer Mode at the right side top corner of chrome://extensions
  6. Click on “Load unpacked”
  7. A popup appears to select folder
  8. Select GitQ folder from the location you previously extracted to, and click on OK.
  9. GitQ Plugin gets installed on Chrome.

Steps to use GitQ:

  1. Navigate to GitHub (https://github.com/)
  2. Navigate to any repository of interest.
  3. You will see visual badges augumented to the repository page.

How to contribute to GitQ

We will be very happy to receive any kind of contributions. Incase of a bug or an enhancement idea or a feature improvement idea, please open an issue or a pull request. Incase of any queries or if you would like to give any suggestions, please feel free to contact Akhila Sri Manasa Venigalla ([email protected]) or Kowndinya Boyalakuntla ([email protected]) or Sridhar Chimalakonda ([email protected]) of RISHA Lab, IIT Tirupati, India.

gitq's People

Contributors

kowndinya2000 avatar

Watchers

 avatar  avatar

gitq's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.