Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Components spring cleaning #113

Closed
5 tasks
tarelli opened this issue Oct 24, 2019 · 4 comments
Closed
5 tasks

Components spring cleaning #113

tarelli opened this issue Oct 24, 2019 · 4 comments
Assignees

Comments

@tarelli
Copy link
Member

tarelli commented Oct 24, 2019

  • Do an inventory of all components inside controls, widgets, interface. The goal is we need to qualify whether to remove or not each of the components which depends on code quality, usage and usefulness. The question we want to answer is: if we were to build a new geppetto application today is this a component that we would use or not? Track their usage (check geppetto-vfb, geppetto-osb, geppetto-application, geppetto-hm, geppetto-netpyne, geppetto-nwbexplorer), check last commit, check code quality (ES6? Full react? is jQuery used? is it used by the ComponentFactory?). For instance, we probably want to remove all controls since nowadays we can just rely on an external library to do the job, e.g. Material UI
  • Review the inventory, agree what we are going to remove.
  • Remove the components
  • Create a card to document all components that we have not removed on org.geppetto.docs
  • Create a card to create a showcase for the components that we have not removed (e.g. https://github.com/openworm/geppetto-client/blob/development/js/components/interface/listViewer/showcase/ListViewerShowcase.js)
@afonsobspinto
Copy link
Member

An initial spreadsheet can be found here (generated with https://github.com/afonsobspinto/GeppettoClientStats)

Next steps:

  • Evaluate effectiveness of the script (by manually go through (some of) the values generated and evaluate them -> new column 'reviewed' will be added)
  • Signal relevant components

Questions:

  1. Definition of full-react
  2. Definition of relevant components (which stats would made a component be signalled as to be removed?)

@afonsobspinto
Copy link
Member

afonsobspinto commented Nov 7, 2019

A new spreadsheet was generated with:

  • New columns: Type, Usage, G., Geppetto.
  • Fix usage: Now it as in consideration G.addWidget and GEPPETTO.ComponentFactory.addComponent
  • Add new repos: geppetto-client, geppetto-hnn
  • Use new branchs: (VirtualFlyBrain/geppetto-vfb, development)

In parallel a sonarqube report was generated. You can find it here

Proposal next steps:

  • Join information of sonarqube to spreedsheet
  • Signal relevant components

Questions:

  1. Presence of false-positives like: https://github.com/openworm/geppetto-client/blob/master/js/components/interface/3dCanvas/SceneController.js#L100

@afonsobspinto
Copy link
Member

A new spreadsheet was generated with:

@filippomc
Copy link
Contributor

Closing as merged into #174

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants