Skip to content

Development Documentation

Jalil F. edited this page Jul 30, 2013 · 9 revisions

Currently available Visualizations

Heatmap

Decision Tree

Mixes

Heatmap & Decision Tree

API Data and how to request it

Use HTTP requests to call data from within a user's session, and add it to your contribution. We utilize the REST API framework, and require all transactions from within the application follow this methodology. Take a look at what requests are available at any time in the RESTful API list.

Using Github's issue tracking

Our team currently uses the Github Issue Tracking to manage hotfixes, bugs, requests, and any other tags that suit our needs. See below to take a look at the current tags we encourage.

hotfix

Bugs that are crucial to the health of the system and must be fixed immediately and pushed to master, following the master-hotfix-dev-issue style of version control.

req

These tags are used for feature requests that are agreed to be added to future builds of the MEV application. Please look at the currently opened req tags and the wontfix tags first before opening a new request. These issues should be specified with backend design goals like comprehensive testing, merging systems, or removing them. Combine commits that solve requests using the Github markdown in the comment of your commit, or use the markdown to reference other related issues.

wontfix

These tags are used for requests or issues that have been deemed not necessary for future projects. They are kept for historical reasons and will be closed as soon as a member of the development team reviews the issue and feels it is required. These tags may be reopened for future designs.

bugs

Not all bugs are created equal, and these tags are for the nagging headaches, while hotfixes are for the heart attacks. Developers are constantly working on the MEV framework, and seek to address bugs as soon as they are identified.

test

These special tags are requests for testing of components of the MEV system. We encourage contributers to include their own testing using the Karma/Jasmine when submitting pull requests, to help with documenting their additions. These tags seek to cover code base that currently has no testing that should be completed.

Clone this wiki locally