Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 2.38 KB

CONTRIBUTE.md

File metadata and controls

51 lines (31 loc) · 2.38 KB
Raw

We are currently few developers actively contributing to the project. Feel free to reach out to us for any help.

Technology stack

The technology stack used in this framework is described below.

Bare Essentials

Git - You guessed it right, we use git for our code versioning following the git branching model suggested by Vincent.

CoffeeScript - For cleaner code, we have adopted CoffeeScript. Please use the below resources to familiarise yourselves.

Jade - For HTML, we use jade templating engine.

AngularJS - JavaScript framework that we employ. Very elegant. Official website has the best documentation.

WebPack - module bundler.

Optional

D3 - Data driven charts

Commit message format

We loosely follow AngularJs Commit Message Format:

First line of the git message has to be in the following format: <type>(<scope>): <subject>

  • <type> here is from this list
  • <scope> is a specific module within SOCRAT you're contributing to, i.e. Core or Charts or PowerCalc
  • <subject> is a description of the change starting with a verb in imperative form, present tense, not capitalized, without period in the end; when commiting unfinished work (e.g. with known bugs), prepend <subject> with WIP.

Second line of the message should contain reference to the corresponding issue (if such exists) in format: SOCR/SOCRAT-issues#<issue>

  • <issue> here is a number of issue from SOCR/SOCRAT-issues repository

Example of commit message:

fix(AppMainMenu): add missing Login button

SOCR/SOCRAT-issues#1

SOCR Datasets for testing

Iris - famous dataset in machine learning [1]. To be able to use it locally for testing, download CSV file and place it under _build/datasets/iris.csv

[1] Lichman, M. (2013). UCI Machine Learning Repository. Irvine, CA: University of California, School of Information and Computer Science.