Skip to content

Commit 35b14de

Browse files
authored
docs(readme): update contributions section
1 parent a313e25 commit 35b14de

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

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

5353
## Contributions
5454

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

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

59-
Then, follow these steps for creating a contribution:
59+
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.
60+
61+
* Before creating an issue, please check the existing issues to see if your topic is already being discussed.
62+
* 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.
63+
64+
> **A Note on Bug Reports**
65+
>
66+
> 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.
67+
>
68+
> 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.
69+
70+
#### 2. Contributing Code via Pull Requests
6071

72+
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.
73+
74+
Then, follow these steps for creating a contribution:
75+
6176
- Fork this project.
6277
- 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.
6378
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.

0 commit comments

Comments
 (0)