|
| 1 | +## Contributing |
| 2 | + |
| 3 | +We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our components. |
| 4 | + |
| 5 | +### Get in touch with the team |
| 6 | + |
| 7 | +Twitter: https://twitter.com/xdevsoftware |
| 8 | +<br/> |
| 9 | + |
| 10 | + |
| 11 | +### Some ways to help: |
| 12 | + |
| 13 | +- **Report bugs**: File issues on GitHub. |
| 14 | +- **Send pull requests**: If you want to contribute code, check out the development instructions below. |
| 15 | + |
| 16 | +We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also. |
| 17 | + |
| 18 | +## Developing |
| 19 | + |
| 20 | +### Software Requirements |
| 21 | +You should have the following things installed: |
| 22 | +* Git |
| 23 | +* Java 11 or 17 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/)) |
| 24 | +* Maven |
| 25 | + |
| 26 | +### Recommended setup |
| 27 | +* Install ``IntelliJ`` (Community Edition is sufficient) |
| 28 | + * Install the following plugins: |
| 29 | + * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields |
| 30 | + * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis |
| 31 | + * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis |
| 32 | + * Import the project |
| 33 | + * Ensure that everything is encoded in ``UTF-8`` |
| 34 | + * Ensure that the JDK/Java-Version is correct |
| 35 | + * To enable AUTOMATIC reloading/restarting while developing and running the app do this (further information in " |
| 36 | + SpringBoot-Devtools" section below; [Source](https://stackoverflow.com/q/33349456)): |
| 37 | + * ``Settings > Build, Execution, Deployment > Compiler``:<br/> |
| 38 | + Enable [``Build project automatically``](https://www.jetbrains.com/help/idea/compiling-applications.html#auto-build) |
| 39 | + * ``Settings > Advanced Settings``:<br/> |
| 40 | + Enable [``Allow auto-make to start even if developed application is currently running``](https://www.jetbrains.com/help/idea/advanced-settings.html#advanced_compiler) |
| 41 | + * To launch the Demo execute the predefined (launch) configuration ``Run Demo`` |
| 42 | + |
| 43 | +#### [SpringBoot-Developer-Tools](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools) |
| 44 | +... should automatically be enabled.<br/> |
| 45 | +If you are changing a file and build the project, parts of the app get restarted.<br/> |
| 46 | +Bigger changes may require a complete restart. |
| 47 | + * [Vaadin automatically reloads the UI on each restart](https://vaadin.com/docs/latest/configuration/live-reload/spring-boot).<br/> |
| 48 | + You can control this behavior with the ``vaadin.devmode.liveReload.enabled`` property (default: ``true``). |
| 49 | + |
| 50 | +## Releasing [](https://github.com/xdev-software/vaadin-addon-template/actions/workflows/release.yml) |
| 51 | + |
| 52 | +Before releasing: |
| 53 | +* Consider doing a [test-deployment](https://github.com/xdev-software/vaadin-addon-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing. |
| 54 | +* Check the [changelog](CHANGELOG.md) |
| 55 | + |
| 56 | +If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes |
| 57 | + |
| 58 | +When the release is finished do the following: |
| 59 | +* Merge the auto-generated PR (with the incremented version number) back into the ``develop`` |
| 60 | +* Upload the generated release asset zip into the [Vaadin Directory](https://vaadin.com/directory) and update the component there |
0 commit comments