Skip to content

Commit b44fe21

Browse files
authored
docs(readme): update contributions section
1 parent 40eb6b8 commit b44fe21

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,34 @@ The issues for this add-on are tracked on its github.com page. All bug reports a
5858

5959
## Contributions
6060

61-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
62-
- Fork this project
61+
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.
62+
63+
#### 1. Reporting Bugs and Requesting Features
64+
65+
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.
66+
67+
* Before creating an issue, please check the existing issues to see if your topic is already being discussed.
68+
* 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.
69+
70+
> **A Note on Bug Reports**
71+
>
72+
> 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.
73+
>
74+
> 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.
75+
76+
#### 2. Contributing Code via Pull Requests
77+
78+
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.
79+
80+
Then, follow these steps for creating a contribution:
81+
82+
- Fork this project.
6383
- 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.
6484
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
65-
- Refer to the fixed issue in commit
66-
- Send a pull request for the original project
67-
- Comment on the original issue that you have implemented a fix for it
85+
- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
86+
- Send a pull request for the original project.
87+
- Comment on the original issue that you have implemented a fix for it.
88+
6889

6990
## License & Author
7091

0 commit comments

Comments
 (0)