Skip to content

Commit c622da8

Browse files
authored
docs(readme): update contributions section
1 parent 908dd46 commit c622da8

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

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

101101
## Contributions
102102

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

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

107-
Then, follow these steps for creating a contribution:
107+
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.
108+
109+
* Before creating an issue, please check the existing issues to see if your topic is already being discussed.
110+
* 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.
111+
112+
> **A Note on Bug Reports**
113+
>
114+
> 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.
115+
>
116+
> 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.
117+
118+
#### 2. Contributing Code via Pull Requests
108119

120+
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.
121+
122+
Then, follow these steps for creating a contribution:
123+
109124
- Fork this project.
110125
- 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.
111126
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.

0 commit comments

Comments
 (0)