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

Agree on conventions across components #5174

Open
2 tasks
Tracked by #5144
romaricpascal opened this issue Jul 26, 2024 · 1 comment
Open
2 tasks
Tracked by #5144

Agree on conventions across components #5174

romaricpascal opened this issue Jul 26, 2024 · 1 comment

Comments

@romaricpascal
Copy link
Member

romaricpascal commented Jul 26, 2024

What

Establish conventions shared by our different components' JavaScript API, both from the perspective of:

  • architecture (eg. events or callbacks? composition or inheritance? getter/setter properties or get.../set... methods?...)
  • naming (eg. leading $ for elements, name of the property storing the component's root element...)

Why

This will help us provide developers a consistent experience across our components, as well as guide us in the implementation of the API of the different componens

Who needs to work on this

Developers

Who needs to review this

Developers

Done when

  • We have a document listing the conventions we've chosen and why we chose them
  • We have trialed (on paper) the conventions on different components to verify they'd work OK with our current set of components
@romaricpascal
Copy link
Member Author

romaricpascal commented Jul 29, 2024

Starting to discuss in this document (internal).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In progress 📝
Development

No branches or pull requests

1 participant