-
Notifications
You must be signed in to change notification settings - Fork 0
Setup
Alex B edited this page Aug 8, 2023
·
29 revisions
If you want to use this template do the following:
All points are already described in the Setup-Guide of standard-maven-template, however here are some differences for Vaadin:
- Add the
XDEV Vaadin Addons
-Team with roleAdmin
Add the Component to Vaadin Directory
- Log into Vaadin Directory with our company account
- Create a new Component (a initial release might be required to sync the component from Maven Central)
- Description
- Component Icon: Our company logo
- Summary: Name of the component
- Description: Description of the component - should look like this:
<Short component description in one sentence> [More infos are available on GitHub](https://github.com/xdev-software/vaadin-chip-combobox) If you found a bug, want to suggest an improvement or have a question please open an issue at GitHub.
- Add matching categories
- Samples
- Add some screenshots how the component looks like (you might reuse the images in
assets
)
- Add some screenshots how the component looks like (you might reuse the images in
- Links
- Add a link to the GitHub repo
- Add a link to the GitHub issue tracker
- Add a link to our company homepage
- All other predefined links can be removed
- Version (initial version)
- Point the release notes to the GitHub Release, e.g.
https://github.com/xdev-software/vaadin-chip-combobox/releases/tag/v3.0.1
- Specify the supported framework, e.g.
Upwards from Vaadin platform 23+
- Maturity: Normally
stable
- Browser compatibility:
- Normally all
Chromium
andFirefox
browser platform independent desktop variants (should be tested before!)- Firefox
- Opera (based Chromium)
- Google Chrome
- Microsoft Edge (based on Chromium)
- Additional:
- If you tested it for mobile platforms you can also check the right side (ignore Windows Phone it's no longer supported)
- Internet Explorer is only available for Windows, no longer supported and can be ignored
- Safari behaves like Internet Explorer for Apple devices and can also be ignored
- Normally all
- Point the release notes to the GitHub Release, e.g.
Important: Do not forget to click onto "Save" (small green button on the top right)