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

Toward clean/fork-friendly/contribution-friendly code #2

Open
2 of 14 tasks
robindemourat opened this issue Sep 22, 2018 · 0 comments
Open
2 of 14 tasks

Toward clean/fork-friendly/contribution-friendly code #2

robindemourat opened this issue Sep 22, 2018 · 0 comments
Labels
enhancement New feature or request priority:low

Comments

@robindemourat
Copy link
Member

robindemourat commented Sep 22, 2018

This is an on-going issue aimed at listing all chore/cleaning tasks remaining to make dicto code base effectively open source, that is easy to read, fork, and improve.

  • add a CONTRIBUTE.md guide
  • add a MANUAL_E2E_CHECKLIST.md guide

Stabilize style system

  • replace redundant inline modification to css theme by css theme changes
  • replace useless inline styles with css system

Clean react code

  • refactor modals with a standard modal component
  • refactor modal contents in separate components
  • spot redundant html patterns and refactor them as reusable components
  •  in features, refactor long layout component by externalizing feature-related components
  • in features, move logic code toContainer components, dedicate Layout components layout/design
  • drop inline callbacks in react components

Local code simplifications

  • use lodash.get instead of multiple existence tests

Add unit tests to utils modules

Code documentation

  • add esdoc header for all functions/classes

Resolve last performance bottlenecks

  • composition edition view : do not load whole corpus data / handle data display in an async way (as for media edition)
  • composition edition view : improve asides edition modal performance

Questions / to decide

Update to react 17 ?

This would mean refactoring everything relying on components livecycle.

Redux data management logic : share code between electron main process and renderer process ?

This would ask to find a way to keep an architecture which work both for webapp and electron app.

@robindemourat robindemourat added the enhancement New feature or request label Sep 22, 2018
@robindemourat robindemourat changed the title Towards clean/fork-friendly/contribution-friendly code Toward clean/fork-friendly/contribution-friendly code Sep 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority:low
Projects
None yet
Development

No branches or pull requests

1 participant