Skip to content

jasperapp/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

description
A flexible and powerful issue reader for GitHub

What is Jasper

Jasper is a tool that allows you to view GitHub issues and pull requests with flexible criteria. For example, you can browse issues and receive update notifications for issues with conditions such as "pull requests you create" or "issues with a nodejs/node bug label".

We call this functionality "Stream" in Jasper, and we can set up a Stream with the following query to view an issue with the conditions described above

author:defunkt is:pr
repo:nodejs/node label:bug is:issue

Stream

Stream is powered by the GitHub Search API, which allows you to use very powerful queries. For example, the following query.

条件 クエリ
Issue created by defunkt author:defunkt is:issue
pull request in the nodejs/node repository repo:nodejs/node is:pr
Issue/pull request with a bug label in a nodejs organization org:nodejs label:bug

And since Stream can use the exact same queries as the GitHub Search API, you have the flexibility to browse issues you are interested in.

{% hint style="info" %} See "Stream queries" and "Stream" for a list of queries that can be used with Stream. {% endhint %}

High flexibility

Currently, there are several tools for viewing GitHub issues, which fall into three main categories

  1. Tools to manage issue viewing and notifications
    GitHub Notifications, DevHub, Trailer and more
  2. Tools for Team Collaboration
    GitHub Scheduled reminders, Pull Panda and more
  3. Tools for project management
    GitHub Projects, Zen Hub and more

Jasper is a tool that belongs to category 1. Normally, tools in this category use the GitHub Notification API. However, Jasper is built using the GitHub Search API, which gives it a lot of flexibility not found in other tools. On the other hand, it may not be as easy to use as other tools. That's why Jasper has been developed with a balance between flexibility and simplicity in mind.

{% hint style="info" %} See "Concept" for more information. {% endhint %}