Code Monkey home page Code Monkey logo

contributed-to's Introduction

contributed-to

An application which displays contributions, i.e. merged pull requests, that a user has made outside of their own projects.

Usage

You can make a HTTP request yourself to api.contributed.jdocklabs.co.uk/user/<user> to receive a JSON payload of information about a particular user.

CLI

A small CLI is also available which can be installed using

go install github.com/jdockerty/contributed-to/cmd/contributed@latest

By default, this points to api.contributed.jdocklabs.co.uk but can be altered using the url flag if you wish to host the application on your own infrastructure with specific GitHub tokens.

You can use the application by calling it like so

# Contributions by one or more users
contributed userOne userTwo

# Verbose contribution information which includes the pull request title
# and permalink
contributed -full userOne userTwo

How it works

The application runs a simple web server which relays the requested GitHub username from the URL as a parameter into the GitHub API.

This utilises the GraphQL GitHub API to fetch the relevant data about a user's merged pull requests, filtering by those which are not their own projects, i.e. a repository under their GitHub username.

The API call is relatively expensive in that it requests the entire history of merged pull requests until there are no more remaining that GitHub has kept a record of. It also caches responses, meaning that the first request may take some time but subsequent requests are served from the cache and are blazingly fast.

contributed-to's People

Contributors

jdockerty avatar

Stargazers

 avatar  avatar

Watchers

 avatar

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.