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

Move compas-save-as-version plugin from compas-open-scd to this repo #16

Open
juancho0202 opened this issue Nov 1, 2023 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@juancho0202
Copy link
Contributor

juancho0202 commented Nov 1, 2023

User Story

As a CoMPAS developer I would like to continue moving plugins out of compas-open-scd, in this case the compas-save-as-version.

Acceptance criteria:

  • Components should be UI based only. So no logic to it
  • Plugins should contain logic and should use the UI component
  • Tests need to be rewritten accodingly
  • Dependencies are imported from their own repositories.
  • Check to see if helper files are only being used for this particular plugin, if so move to repository. Otherwise, figure where it should be implemented and import dependancy.
  • Include screenshot tests if needed
  • Document the new API of the plugin
  • Add TypeDoc for documentation to the repository
  • Create storybook for the plugin

TBD:

  • How to handle translations
  • How to handle logging
  • Save-as-version now opens the entire document just to be rewritten. This needs to be refactored so it only uses the document ID
@juancho0202 juancho0202 added the enhancement New feature or request label Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant