Merge pull request #67 from MisterPhilip/development

1.0.0 release

.github/issue_template.md

@@ -0,0 +1,16 @@
+### Browser & Omnibug versions
+
+
+### Expected behavior
+
+
+### Actual behavior
+
+
+### Steps to reproduce the behavior
+
+1.
+
+
+### Other notes
+

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+Reference Issue # .
+
+Changes proposed in this pull request:
+
+ -
+ -
+ -
+

.gitignore

@@ -15,3 +15,21 @@ build/
 
 # Grunt work
 .grunt/
+
+# Tests/Coverage
+.nyc_output/
+coverage/
+
+/test/*
+!/test/core
+!/test/providers
+!/test/helpers/
+!/test/polyfills.js
+
+# Generated files
+src/providers.js
+platform/
+
+# Ignore built CSS files
+.sass-cache/
+src/**/*.css

.travis.yml

@@ -1,3 +1,5 @@
 language: node_js
 node_js:
   - "8.9.1"
+after_success:
+  - "./node_modules/.bin/nyc report --reporter=text-lcov | ./node_modules/.bin/coveralls"

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at philip@omnibug.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+Contributing to Omnibug
+==========
+
+Omnibug is a browser plugin to ease developing & maintaining web metrics implementations. Each outgoing request
+(sent by the browser) is checked for a pattern; if a match occurs, the URL is displayed in a panel, and decoded to show
+the details of the request
+
+### Issues
+Find an issue? That's not good! Here's a list of information that we needed when opening a Github issue:
+
+ * The browser name & version
+ * OS name & version
+ * Version of Omnibug you're running (clicking on "More" next to Omnibug in Firefox will show this)
+ * The issue you're having
+ * A way to replicate it (ideally a page we can access)
+
+### Installing locally
+
+To do any work, fork the original repository, and clone it locally. Then, install via [NPM](https://www.npmjs.com/):
+```
+$ npm install
+```
+
+##### Chrome
+To install the local version in Chrome, go to the [chrome://extensions/](Extensions) settings, then be sure "Developer Mode" 
+is checked. Once developer mode is enabled, select "Load unpacked extension..." and point to the `/platform/chromium/manifest.json` 
+file. Learn more at [Google's docs](https://developer.chrome.com/extensions/getstarted).
+
+##### Firefox
+To install the local version in Firefox, go to the [about:addons](Add-ons Manager), then click the settings/gear icon. 
+From there, select "[Debug Add-ons](about:debugging#addons)", and then select "Load Temporary Add-on" and point to the `/platform/firefox/manifest.json` 
+file. Learn more at [Mozilla's docs](https://developer.mozilla.org/en-US/Add-ons/WebExtensions).
+
+##### Edge
+Edge is currently not supported, due to missing APIs. Maybe one day, sigh...
+
+### Coding Styles
+
+@TODO
+
+### Adding a Provider
+
+@TODO
+
+When adding a provider, be sure to add a unit test that covers a wide range of use cases.
+
+### Testing
+
+Testing is done via [AVA](https://github.com/avajs/ava) and can be executed by running the following command:
+```
+$ npm run test
+```
+
+### Building
+
+Since each browser requires slightly different manifests & some need polyfills, [Grunt](https://gruntjs.com/) takes care 
+of building browser-specific code from the generic code base. To build for all browsers:
+```
+$ grunt build-extensions
+```
+
+You can also specify what browser to build for (`chrome`, `firefox`, or `edge`):
+```
+$ grunt build-extensions chrome
+```
+
+This will output to the `/platform/$BROWSER` folders, as well as output a `.zip` for distribution in the `/build/$BROWSER` folders.