Skip to content

Commit 9d12ee2

Browse files
authored
docs(readme): update contributions section
1 parent 8f5ecba commit 9d12ee2

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,27 @@ The issues for this add-on are tracked on its github.com page. All bug reports a
6363

6464
## Contributions
6565

66-
Contributions are welcome, but there are no guarantees that they are accepted as such.
66+
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.
6767

68-
As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requirements.
68+
#### 1. Reporting Bugs and Requesting Features
6969

70-
Then, follow these steps for creating a contribution:
70+
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.
71+
72+
* Before creating an issue, please check the existing issues to see if your topic is already being discussed.
73+
* 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.
74+
75+
> **A Note on Bug Reports**
76+
>
77+
> 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.
78+
>
79+
> 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.
80+
81+
#### 2. Contributing Code via Pull Requests
7182

83+
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.
84+
85+
Then, follow these steps for creating a contribution:
86+
7287
- Fork this project.
7388
- 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.
7489
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
@@ -91,3 +106,4 @@ To do so, just add ```com.flowingcode``` to the ```vaadin.allowed-packages``` pr
91106
```vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode```
92107

93108
More information on Spring scanning configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).
109+

0 commit comments

Comments
 (0)