Please feel free to contribute ideas, bug reports, documentation, code, and anything else that comes to mind!
Running your HTML through tidy using the provided config file is appreciated. Here is a suggestion of how to run tidy:
tidy -config tidyconfig.txt -file errors.txt -modify index.html
Running your Javascript through js-beautify is appreciated:
js-beautify --indent-size=4 -n --replace plots.js
If you would like to run your code through jshint (2.6.3 for now), this command is suggested:
java -jar rhino-1.7.9.jar jshint-rhino.js plots.js undef=true,devel=true,maxerr=999
Running your Python through flake8 is appreciated. Some day it would be nice to use Black.
We have the following principles when writing Python:
- Support both Python 2 (for now) and Python 3.
- Use the batteries included in the standard library rather than relying on any dependencies. (This makes writing code compatible with both Python 2 and Python 3 more difficult. https://python-future.org/compatible_idioms.html is a helpful resource.)
Please run tests with both python test.py (Python 2) and python3 test.py (Python 3). Both versions of Python are tested at https://travis-ci.org/IQSS/dataverse-metrics