You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-5Lines changed: 25 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,14 +48,33 @@ The issues for this add-on are tracked on its github.com page. All bug reports a
48
48
49
49
## Contributions
50
50
51
-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
51
+
Contributions are welcome. There are two primary ways you can contribute: by reporting issues or by submitting code changes through pull requests. To ensure a smooth and effective process for everyone, please follow the guidelines below for the type of contribution you are making.
52
52
53
-
- Fork this project
53
+
#### 1. Reporting Bugs and Requesting Features
54
+
55
+
Creating an issue is a highly valuable contribution. If you've found a bug or have an idea for a new feature, this is the place to start.
56
+
57
+
* Before creating an issue, please check the existing issues to see if your topic is already being discussed.
58
+
* If not, create a new issue, choosing the right option: "Bug Report" or "Feature Request". Try to keep the scope minimal but as detailed as possible.
59
+
60
+
> **A Note on Bug Reports**
61
+
>
62
+
> Please complete all the requested fields to the best of your ability. Each piece of information, like the environment versions and a clear description, helps us understand the context of the issue.
63
+
>
64
+
> While all details are important, the **[minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)** is the most critical part of your report. It's essential because it removes ambiguity and allows our team to observe the problem firsthand, exactly as you are experiencing it.
65
+
66
+
#### 2. Contributing Code via Pull Requests
67
+
68
+
As a first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requirements.
69
+
70
+
Then, follow these steps for creating a contribution:
71
+
72
+
- Fork this project.
54
73
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
55
74
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
56
-
-Refer to the fixed issue in commit
57
-
- Send a pull request for the original project
58
-
- Comment on the original issue that you have implemented a fix for it
75
+
-For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
76
+
- Send a pull request for the original project.
77
+
- Comment on the original issue that you have implemented a fix for it.
59
78
60
79
## License & Author
61
80
@@ -103,3 +122,4 @@ To do so, just add ```com.flowingcode``` to the ```vaadin.allowed-packages``` pr
More information on Spring scanning configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).
0 commit comments