Skip to content

Commit 1b8e16c

Browse files
authored
docs(readme): update contributions section
1 parent e4b6613 commit 1b8e16c

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

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

2828
## Contributions
2929

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

32-
- Fork this project
32+
#### 1. Reporting Bugs and Requesting Features
33+
34+
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.
35+
36+
* Before creating an issue, please check the existing issues to see if your topic is already being discussed.
37+
* 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.
38+
39+
> **A Note on Bug Reports**
40+
>
41+
> 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.
42+
>
43+
> 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.
44+
45+
#### 2. Contributing Code via Pull Requests
46+
47+
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.
48+
49+
Then, follow these steps for creating a contribution:
50+
51+
- Fork this project.
3352
- 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.
3453
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
35-
- Refer to the fixed issue in commit
36-
- Send a pull request for the original project
37-
- Comment on the original issue that you have implemented a fix for it
54+
- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
55+
- Send a pull request for the original project.
56+
- Comment on the original issue that you have implemented a fix for it.
3857

3958
## License & Author
4059

0 commit comments

Comments
 (0)