Skip to content

Commit 0a1cd2d

Browse files
authored
docs(readme): update contributions section
1 parent a6f81fd commit 0a1cd2d

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
@@ -36,14 +36,33 @@ The issues for this add-on are tracked on its github.com page. All bug reports a
3636

3737
## Contributions
3838

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

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

4867
## License & Author
4968

@@ -56,3 +75,4 @@ ImageComparisonSliderAddon is written by Flowing Code S.A.
5675
## Getting started
5776

5877
Add your code samples in this section
78+

0 commit comments

Comments
 (0)