ParaView ArcticViewer is meant to be an Open Source application for interactive data exploration.
The following guide explains our software process and the tools use to build and develop this framework.
Software process
We rely on Semantic-release to manage our change log, tagging and publishing to NPM via Travis.
In order to maintain that process each commit message should follow a specific formatting. To ensure that formating, we use Commitizen which can be triggered via the following command line. Additional information can be found here.
$ git cz
Then a set of questions will be presented to you like the following ones:
$ git cz
Line 1 will be cropped at 100 characters. All other lines will be wrapped
after 100 characters.
? Select the type of change that you're committing: (Use arrow keys)
feat: A new feature
fix: A bug fix
docs: Documentation only changes
❯ style: Changes that do not affect the meaning of the code
(white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug or adds a feature
perf: A code change that improves performance
(Move up and down to reveal more choices)
? Denote the scope of this change ($location, $browser, $compile, etc.):
ESLint
? Write a short, imperative tense description of the change:
Update code formatting to comply with our ESLint specification
? Provide a longer description of the change:
? List any breaking changes or issues closed by this change:
Will generate the following commit message:
commit 1a31ecfcc2f6f4283e51187a24ce0e9d9c17ae54
Author: Sebastien Jourdain <sebastien.jourdain@kitware.com>
Date: Mon Dec 21 09:29:21 2015 -0700
style(ESLint): Update code formatting to comply with our ESLint specification
Code editing
Sublime Text 3 with the following set of plugins. To install plugins you will have to first install the Package constrol.
Then installing new plugin should start with: Ctrl/Cmd + Shift + p Install
Git + GitGutter
With GitGutter, you can see which lines have been added, deleted or modified in the gutter.
Babel
This plugin adds proper syntax highlighting to your ES6/2015 and React JSX code.
JsFormat
Once installed, to use JSFormat, go to your JS file and hit Ctrl + Alt + f on Windows/Linux or Ctrl + ⌥ + f on Mac. Alternatively, use the context menu.
Sublime-Linter + SublimeLinter-eslint
More information available here.
$ npm install -g eslint