Skip to content

Commit 2260c3e

Browse files
paodbjavier-godoy
authored andcommitted
docs: update contributions section on readme
1 parent 77a59c7 commit 2260c3e

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

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

4949
## Contributions
5050

51-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
52-
- Fork this project
51+
Contributions are welcome, but there are no guarantees that they are accepted as such.
52+
53+
As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requirements.
54+
55+
Then, follow these steps for creating a contribution:
56+
57+
- Fork this project.
5358
- 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.
5459
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
55-
- Refer to the fixed issue in commit
56-
- Send a pull request for the original project
57-
- Comment on the original issue that you have implemented a fix for it
60+
- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
61+
- Send a pull request for the original project.
62+
- Comment on the original issue that you have implemented a fix for it.
5863

5964
## License & Author
6065

0 commit comments

Comments
 (0)