Skip to content

Commit cb17fa8

Browse files
javier-godoypaodb
authored andcommitted
doc: update Contributions instructions
1 parent 48acd65 commit cb17fa8

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

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

6464
## Contributions
6565

66-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
66+
Contributions are welcome, but there are no guarantees that they are accepted as such.
6767

68-
- Fork this project
68+
As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requeriments.
69+
70+
Then, follow these steps for creating a contibution:
71+
72+
- Fork this project.
6973
- 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.
7074
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
71-
- Refer to the fixed issue in commit
72-
- Send a pull request for the original project
73-
- Comment on the original issue that you have implemented a fix for it
75+
- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
76+
- Send a pull request for the original project.
77+
- Comment on the original issue that you have implemented a fix for it.
7478

7579
## License & Author
7680

0 commit comments

Comments
 (0)