Skip to content

Commit c14d4be

Browse files
committed
📝 Docs(README.md): update contributing section with info about commits and changelog
1 parent f2fd6bb commit c14d4be

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

‎README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,14 @@ Full details for both licenses can be found in the [LICENSE][vuegen-license] fil
406406

407407
## Contributing
408408

409-
VueGen is an open-source project, and we welcome contributions of all kinds via GitHub issues and pull requests. You can report bugs, suggest improvements, propose new features, or implement changes. Please follow the guidelines in the [CONTRIBUTING](CONTRIBUTING.md) file to ensure that your contribution is easily integrated into the project.
409+
VueGen is an open-source project, and we welcome contributions of all kinds via GitHub issues and pull requests.
410+
You can report bugs, suggest improvements, propose new features, or implement changes.
411+
412+
We follow the [Conventional Commits][conventional-commits] specification for commit messages and use the
413+
[changelog-from-release][changelog-from-release-repo] tool to automatically generate the [CHANGELOG](CHANGELOG.md).
414+
415+
Please follow the guidelines in the [CONTRIBUTING](CONTRIBUTING.md) file to ensure that your contribution is
416+
easily integrated into the project.
410417

411418
## Credits and acknowledgements
412419

@@ -488,6 +495,8 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
488495
[st-cloud]: https://streamlit.io/cloud
489496
[stlite_repo]: https://github.com/whitphx/stlite
490497
[st-forum-exe]: https://discuss.streamlit.io/t/streamlit-deployment-as-an-executable-file-exe-for-windows-macos-and-android/6812
498+
[conventional-commits]: https://www.conventionalcommits.org/
499+
[changelog-from-release-repo]: https://github.com/rhysd/changelog-from-release
491500
[Mona]: https://multiomics-analytics-group.github.io/
492501
[Biosustain]: https://www.biosustain.dtu.dk/
493502
[scriberia]: https://www.scriberia.co.uk/

0 commit comments

Comments
 (0)