The api-analytics's discuss from bazaarvoice

api-analytics's Issues

Example code should follow best practices

If we are providing this repo as an example of how to implement our analytics, we really need to follow best practices if we want to avoid support issues and ensure that our recommendations are credible. I don't feel it's sufficient to just have a sentence that says the code isn't optimal.

As examples:

onscroll and resize events should be debounced to avoid performance issues.
Is jQuery required? Why? Does it have to be loaded in the <head> of the document, blocking other resources? Performance-minded customers should resist this, and may resist jQuery itself, especially on mobile.
Do other script files need to be loaded in the <head>, blocking other resources? Performance-minded customers should resist this.
Some files are minified and some are not; is there a reason to provide a minified version of the tracker code here? Do we expect customers to host this code themselves or do we host it for them? If they are hosting it, they should minify it as part of their own process. This at least needs to be documented.

Add OWNERS, LICENSE, CONTRIBUTING files

Image - console.log

Extension Image

images

Counter Image

main.js event handlers don't seem to do anything

For example https://github.com/bazaarvoice/api-analytics/blob/master/js/main.js#L178 and other functions in this file don't seem to do anything.

Conversion Image

Extension Image

Include specific instructions on running the code

The instructions right now on how to run the code don't really give me a lot of help. It would be useful to provide specific instructions and, if required, specific examples of config files to support those instructions. For example, you could provide examples using python's simpleHTTPServer or Node's http-server.

Recommend Projects