Skip to content

Commit 96ab041

Browse files
authored
docs(readme): update contributions section
1 parent 190f038 commit 96ab041

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,33 @@ The issues for this add-on are tracked on its github.com page. All bug reports a
4242

4343
## Contributions
4444

45-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
45+
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.
4646

47-
- Fork this project
47+
#### 1. Reporting Bugs and Requesting Features
48+
49+
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.
50+
51+
* Before creating an issue, please check the existing issues to see if your topic is already being discussed.
52+
* 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.
53+
54+
> **A Note on Bug Reports**
55+
>
56+
> 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.
57+
>
58+
> 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.
59+
60+
#### 2. Contributing Code via Pull Requests
61+
62+
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.
63+
64+
Then, follow these steps for creating a contribution:
65+
66+
- Fork this project.
4867
- 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.
4968
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
50-
- Refer to the fixed issue in commit
51-
- Send a pull request for the original project
52-
- Comment on the original issue that you have implemented a fix for it
69+
- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
70+
- Send a pull request for the original project.
71+
- Comment on the original issue that you have implemented a fix for it.
5372

5473
## License & Author
5574

@@ -107,3 +126,4 @@ To do so, just add ```com.flowingcode``` to the ```vaadin.whitelisted-packages``
107126
```vaadin.whitelisted-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode```
108127

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

0 commit comments

Comments
 (0)