contribution guide

Contribution Guide

Thank you for your interest in improving Selldone Components. This page explains how to propose changes, how to set up the library for local development, and the conventions we follow. The organization-wide rules are in the Selldone Contributing guide and the Code of Conduct; please read them first.

Ways to contribute

• Report a bug — open an issue with steps to reproduce, the component name and your browser.
• Suggest an improvement — open an issue describing the use case before you write a large change.
• Fix or improve code — send a pull request.
• Improve translations — texts live in selldone/translate, not in this repository.
• Report a vulnerability — never in a public issue. Email security@selldone.com and see the Security policy.

Getting started

1. Fork selldone/components to your GitHub account.
2. Clone your fork and add the original repository as upstream to keep your fork in sync.
3. Create a branch for each change.

Local development

The library is consumed as source by an app such as the Storefront. Link it with Yarn (from DEVELOPMENT.md):

# In this repository: link the library
yarn link

# Link the other Selldone libraries to this project
yarn link "@selldone/core-js"
yarn link "@selldone/sdk-storefront"
yarn link "@selldone/sdk-backoffice"
yarn link "@selldone/sdk-community"
yarn link "@selldone/sdk-vendor"
yarn link "@selldone/page-builder"

Then, in your app, run yarn link "@selldone/components-vue" and start the dev server. To undo a link, run yarn unlink "<package>" in the app and then yarn install.

Conventions

• Naming — start component names with the family prefix: S storefront, B backoffice, U UI, C community. Put each component in its own folder under the matching top-level folder. See Component Families.
• Texts — never hard-code user-facing strings; use $t() keys from Translate. Add new English keys there.
• APIs — call Selldone through the SDKs (window.$storefront, window.$backoffice, …), not raw URLs.
• Style — follow the existing code style (TypeScript, Vue 3 options API with Vuetify 3). The project uses ESLint and Prettier.
• Comments — explain non-obvious logic and keep the existing comment structure.
• Performance — load heavy dependencies (charts, maps, editors) asynchronously, as components-mandetory.ts does for apexchart, u-qrcode and u-lottie.

Pull request process

1. Push your branch to your fork.
2. Open a pull request against main with a clear description, screenshots for UI changes, and the components you touched.
3. Address review feedback.
4. A maintainer merges the pull request when it is approved.

Questions

Ask in an issue or see Contact.

Next steps

• Getting Started
• Component Families
• Organization support