Skip to content

barriosnahuel/spokesman

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

spokesman

It's a GitHub's notifications interpreter for Chrome

version Semver experimental Code Climate Issue Count

Project status

Throughput Graph

Working on: Issues ready to take

Screenshots

See listing in Chrome's store.

Supported events

The following events are those ones that are firing desktop notifications right now. We are working hard to add more events as soon as possible!

  • CreateEvent
  • DeleteEvent
  • IssueCommentEvent
  • IssuesEvent
  • PullRequestEvent
  • PullRequestReviewCommentEvent
  • PushEvent
  • ReleaseEvent
  • WatchEvent

To see the full list of events published by the GitHub API take a look to this link.

Manifest notes

content_security_policy

It is required because of jsrender. If

script-src 'self' 'unsafe-eval'; object-src 'self'

is not present, then it fails and log:

Refused to evaluate a string as JavaScript because 'unsafe-eval' is not an allowed source of script in the following Content Security Policy directive: "default-src 'self'". Note that 'script-src' was not explicitly set, so 'default-src' is used as a fallback.

Contributing

Setup your Chrome

  1. Clone this repo in your favourite directory.
  2. Open Chrome and go to chrome://extensions
  3. Assure Developer mode is checked, if not then check it.
  4. Click on Load unpacked extension, then select the extension directory of the cloned repository.
  5. Setup your username and personal access token on the settings page.

Important: Take into account that for private repositories your access token must have the repo permission enabled.

Configure properties file

Edit properties.json file in the root directory (just next to this file) and add

  • "testing": true <= It's an important flag to prevent checking for new events once a minute.

icons

Icons were taken from here and here. In the other hand, event's icons were taken from:

  • Branch: here.
  • Tag: here.
  • Comment: here.
  • Repository: here.
  • Issue: here.
  • Issue labeled/unlabeled: here.
  • Issue assigned: here.
  • Issue unassigned: here.
  • Pull Request: It's the same used for the branch rotated 180º.
  • Release: here.
  • Star: here.

Colors:

  • Opened: #6cc644
  • Closed: #bd2c00
  • Merged: #6e5494
  • Comments: #607d8b

Sizes:

  • Single: 256px (original) ==> 200px (scaled-centered)
  • Double: 128px

Used libraries