Merge pull request #30 from barriosnahuel/develop

Release v1.0.0

.codeclimate.yml

@@ -0,0 +1,20 @@
+---
+engines:
+  csslint:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - javascript
+      - css
+  eslint:
+    enabled: true
+  fixme:
+    enabled: true
+ratings:
+  paths:
+  - "**.css"
+  - "**.js"
+exclude_paths:
+- store/**/*

.csslintrc

@@ -0,0 +1,2 @@
+--exclude-exts=.min.css
+--ignore=adjoining-classes,box-model,ids,order-alphabetical,unqualified-attributes

.eslintignore

@@ -0,0 +1,2 @@
+**/*{.,-}min.js
+**/*{.,-}min.js.map

.eslintrc

@@ -0,0 +1,213 @@
+ecmaFeatures:
+  modules: true
+  jsx: true
+
+env:
+  amd: false
+  browser: true
+  es6: true
+  jquery: true
+  node: false
+
+# http://eslint.org/docs/rules/
+rules:
+  # Possible Errors
+  comma-dangle: [2, never]
+  no-cond-assign: 2
+  no-console: 0
+  no-constant-condition: 2
+  no-control-regex: 2
+  no-debugger: 2
+  no-dupe-args: 2
+  no-dupe-keys: 2
+  no-duplicate-case: 2
+  no-empty: 2
+  no-empty-character-class: 2
+  no-ex-assign: 2
+  no-extra-boolean-cast: 2
+  no-extra-parens: 0
+  no-extra-semi: 2
+  no-func-assign: 2
+  no-inner-declarations: [2, functions]
+  no-invalid-regexp: 2
+  no-irregular-whitespace: 2
+  no-negated-in-lhs: 2
+  no-obj-calls: 2
+  no-regex-spaces: 2
+  no-sparse-arrays: 2
+  no-unexpected-multiline: 2
+  no-unreachable: 2
+  use-isnan: 2
+  valid-jsdoc: 0
+  valid-typeof: 2
+
+  # Best Practices
+  accessor-pairs: 2
+  block-scoped-var: 0
+  complexity: [2, 6]
+  consistent-return: 0
+  curly: 0
+  default-case: 0
+  dot-location: 0
+  dot-notation: 0
+  eqeqeq: 2
+  guard-for-in: 2
+  no-alert: 2
+  no-caller: 2
+  no-case-declarations: 2
+  no-div-regex: 2
+  no-else-return: 0
+  no-empty-label: 2
+  no-empty-pattern: 2
+  no-eq-null: 2
+  no-eval: 2
+  no-extend-native: 2
+  no-extra-bind: 2
+  no-fallthrough: 2
+  no-floating-decimal: 0
+  no-implicit-coercion: 0
+  no-implied-eval: 2
+  no-invalid-this: 0
+  no-iterator: 2
+  no-labels: 0
+  no-lone-blocks: 2
+  no-loop-func: 2
+  no-magic-number: 0
+  no-multi-spaces: 0
+  no-multi-str: 0
+  no-native-reassign: 2
+  no-new-func: 2
+  no-new-wrappers: 2
+  no-new: 2
+  no-octal-escape: 2
+  no-octal: 2
+  no-proto: 2
+  no-redeclare: 2
+  no-return-assign: 2
+  no-script-url: 2
+  no-self-compare: 2
+  no-sequences: 0
+  no-throw-literal: 0
+  no-unused-expressions: 2
+  no-useless-call: 2
+  no-useless-concat: 2
+  no-void: 2
+  no-warning-comments: 0
+  no-with: 2
+  radix: 2
+  vars-on-top: 0
+  wrap-iife: 2
+  yoda: 0
+
+  # Strict
+  strict: 0
+
+  # Variables
+  init-declarations: 0
+  no-catch-shadow: 2
+  no-delete-var: 2
+  no-label-var: 2
+  no-shadow-restricted-names: 2
+  no-shadow: 0
+  no-undef-init: 2
+  no-undef: 0
+  no-undefined: 0
+  no-unused-vars: 0
+  no-use-before-define: 0
+
+  # Node.js and CommonJS
+  callback-return: 2
+  global-require: 2
+  handle-callback-err: 2
+  no-mixed-requires: 0
+  no-new-require: 0
+  no-path-concat: 2
+  no-process-exit: 2
+  no-restricted-modules: 0
+  no-sync: 0
+
+  # Stylistic Issues
+  array-bracket-spacing: 0
+  block-spacing: 0
+  brace-style: 0
+  camelcase: 0
+  comma-spacing: 0
+  comma-style: 0
+  computed-property-spacing: 0
+  consistent-this: 0
+  eol-last: 0
+  func-names: 0
+  func-style: 0
+  id-length: 0
+  id-match: 0
+  indent: 0
+  jsx-quotes: 0
+  key-spacing: 0
+  linebreak-style: 0
+  lines-around-comment: 0
+  max-depth: 0
+  max-len: 0
+  max-nested-callbacks: 0
+  max-params: 0
+  max-statements: [2, 30]
+  new-cap: 0
+  new-parens: 0
+  newline-after-var: 0
+  no-array-constructor: 0
+  no-bitwise: 0
+  no-continue: 0
+  no-inline-comments: 0
+  no-lonely-if: 0
+  no-mixed-spaces-and-tabs: 0
+  no-multiple-empty-lines: 0
+  no-negated-condition: 0
+  no-nested-ternary: 0
+  no-new-object: 0
+  no-plusplus: 0
+  no-restricted-syntax: 0
+  no-spaced-func: 0
+  no-ternary: 0
+  no-trailing-spaces: 0
+  no-underscore-dangle: 0
+  no-unneeded-ternary: 0
+  object-curly-spacing: 0
+  one-var: 0
+  operator-assignment: 0
+  operator-linebreak: 0
+  padded-blocks: 0
+  quote-props: 0
+  quotes: 0
+  require-jsdoc: 0
+  semi-spacing: 0
+  semi: 0
+  sort-vars: 0
+  space-after-keywords: 0
+  space-before-blocks: 0
+  space-before-function-paren: 0
+  space-before-keywords: 0
+  space-in-parens: 0
+  space-infix-ops: 0
+  space-return-throw-case: 0
+  space-unary-ops: 0
+  spaced-comment: 0
+  wrap-regex: 0
+
+  # ECMAScript 6
+  arrow-body-style: 0
+  arrow-parens: 0
+  arrow-spacing: 0
+  constructor-super: 0
+  generator-star-spacing: 0
+  no-arrow-condition: 0
+  no-class-assign: 0
+  no-const-assign: 0
+  no-dupe-class-members: 0
+  no-this-before-super: 0
+  no-var: 0
+  object-shorthand: 0
+  prefer-arrow-callback: 0
+  prefer-const: 0
+  prefer-reflect: 0
+  prefer-spread: 0
+  prefer-template: 0
+  require-yield: 0

README.md

@@ -1,19 +1,31 @@
 # spokesman
 It's a GitHub's notifications interpreter for Chrome
 
+[![version](https://img.shields.io/github/release/barriosnahuel/spokesman.svg)](chrome.google.com/webstore/detail/epemkmimdjecaegobcafcblljdjjicpm)
+[![Semver](http://img.shields.io/SemVer/2.0.0.png)](http://semver.org/spec/v2.0.0.html)
+[![experimental](https://img.shields.io/badge/stability-experimental-yellow.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)
+[![Code Climate](https://codeclimate.com/github/barriosnahuel/spokesman/badges/gpa.svg)](https://codeclimate.com/github/barriosnahuel/spokesman)
+[![Issue Count](https://codeclimate.com/github/barriosnahuel/spokesman/badges/issue_count.svg)](https://codeclimate.com/github/barriosnahuel/spokesman)
+
 ## Screenshots
 
-[Here](https://goo.gl/vBtHnG)
+See [listing](https://goo.gl/vBtHnG) in Chrome's store.
 
-## Use it
+## Supported events
 
-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 root directory of the cloned repository.
-5. Setup your username and personal access token on the settings page.
+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!
 
-**Important:** Take into account that for private repos your access token *must* have the `repo` permission enabled.
+- 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](https://developer.github.com/v3/activity/events/types/).
 
 ## Manifest notes
 
@@ -28,47 +40,24 @@ 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.
-
-### icons
-
-Icons were taken from [here](http://www.iconsdb.com/black-icons/megaphone-2-icon.html) and [here](http://www.flaticon.com/free-icon/leader-with-loudspeaker_75899#term=megaphone&page=1&position=12).
-In the other hand, event's icons were taken from:
-- Branch: [here](http://www.flaticon.com/free-icon/two-arrows-bifurcation_60687#term=bifurcation&page=1&position=10).
-- Tag: [here](http://www.flaticon.com/free-icon/black-shop-tag_16260#term=tag&page=1&position=15).
-- Comment: [here](http://www.flaticon.com/free-icon/comments_25360#term=comments&page=1&position=1).
-- Repository: [here](http://www.flaticon.com/free-icon/data-management-interface-symbol-with-gears-and-binary-code-numbers_36094#term=code&page=1&position=1).
-- Issue: [here](http://www.flaticon.com/free-icon/checked-list_13194#term=task&page=1&position=1).
-- Issue labeled/unlabeled: [here](http://www.flaticon.com/free-icon/label_24141#term=label&page=1&position=11).
-- Issue assigned: [here](http://www.flaticon.com/free-icon/new-user_72648#term=add-user&page=1&position=3).
-- Issue unassigned: [here](http://www.flaticon.com/free-icon/remove-user_72830#term=delete-user&page=1&position=2).
-- Release: [here](http://www.flaticon.com/free-icon/checkered-flag_62499#term=flag&page=2&position=23).
-
-Colors:
-- Opened: #6cc644
-- Closed: #bd2c00
-- Merged: #6e5494
-
-## 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!
+
+## Contributing
 
-- CreateEvent
-- DeleteEvent
-- IssueCommentEvent
-- IssuesEvent
-- PullRequestEvent
-- PullRequestReviewCommentEvent
-- PushEvent
-- ReleaseEvent
+### Setup your Chrome
 
-To see the full list of events published by the GitHub API take a look to [this link](https://developer.github.com/v3/activity/events/types/).
+1. Clone this repo in your favourite directory.
+2. Open Chrome and go to `chrome://extensions`
+3. Assure **Developer mode** isAdded  checked, if not then check it.
+4. Click on **Load unpacked extension**, then select the root directory of the cloned repository.
+5. Setup your username and personal access token on the settings page.
 
-## Develop and testing
+**Important:** Take into account that for private repos 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.
-
-
+
 Sample file:
 
 ```json
@@ -87,9 +76,35 @@ Sample file:
 }
 ```
 
-## Used libraries
+### icons
+
+Icons were taken from [here](http://www.iconsdb.com/black-icons/megaphone-2-icon.html) and [here](http://www.flaticon.com/free-icon/leader-with-loudspeaker_75899#term=megaphone&page=1&position=12).
+In the other hand, event's icons were taken from:
+- Branch: [here](http://www.flaticon.com/free-icon/code-fork-symbol_25406#term=software&page=1&position=22).
+- Tag: [here](http://www.flaticon.com/free-icon/black-shop-tag_16260#term=tag&page=1&position=15).
+- Comment: [here](http://www.flaticon.com/free-icon/comments_25360#term=comments&page=1&position=1).
+- Repository: [here](http://www.flaticon.com/free-icon/data-management-interface-symbol-with-gears-and-binary-code-numbers_36094#term=code&page=1&position=1).
+- Issue: [here](http://www.flaticon.com/free-icon/checked-list_13194#term=task&page=1&position=1).
+- Issue labeled/unlabeled: [here](http://www.flaticon.com/free-icon/label_24141#term=label&page=1&position=11).
+- Issue assigned: [here](http://www.flaticon.com/free-icon/new-user_72648#term=add-user&page=1&position=3).
+- Issue unassigned: [here](http://www.flaticon.com/free-icon/remove-user_72830#term=delete-user&page=1&position=2).
+- Pull Request: It's the same used for the branch rotated 180º.
+- Release: [here](http://www.flaticon.com/free-icon/checkered-flag_62499#term=flag&page=2&position=23).
+- Star: [here](http://www.flaticon.com/free-icon/mark-as-favorite-star_60973#term=star&page=1&position=3).
+
+Colors:
+- Opened: #6cc644
+- Closed: #bd2c00
+- Merged: #6e5494
+- Comments: #607d8b
+
+Sizes:
+- Single: 256px (original) ==> 200px (scaled-centered)
+- Double: 128px
+
+### Used libraries
 
 - https://www.getbootstrap.com
 - https://www.jquery.com
 - https://www.jsviews.com
-- https://www.bootstraptoggle.com
+- https://www.bootstraptoggle.com