BioDrop
BioDrop copied to clipboard
EddieHubCommunity
[DOCS] Contributing section in docs for conventional commits style
Description
I think in the docs it would be useful to have a section on our commits convention and a link to conventional commits website
https://linkfree.eddiehub.io/docs
Screenshots
No response
Additional information
No response
It's great having you contribute to this project
Welcome to the community :nerd_face:If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
@eddiejaoude can i work on this!
Hey @khanjasir90 do you need any help with this?
I had a doubt, for each issue raised do we have to get it assigned or can we directly start working on it and raise a PR, help me out as I am figuring out how open source community works
I had a doubt, for each issue raised do we have to get it assigned or can we directly start working on it and raise a PR, help me out as I am figuring out how open source community works
@predatorprasad yes it is best to have issues assigned. Please also take a look at the labels. For example, when an issue is ready to be worked on it will have the label status: ready for dev.
Thanks a lot for your reply
On Fri, 3 Feb 2023, 8:17 pm Sara Jaoude, @.***> wrote:
Unassigned due to no recent activity.
— Reply to this email directly, view it on GitHub https://github.com/EddieHubCommunity/LinkFree/issues/2583#issuecomment-1415976455, or unsubscribe https://github.com/notifications/unsubscribe-auth/AWTOXRMRKTOG2ME7CSSKEN3WVULAHANCNFSM6AAAAAATOZWY4A . You are receiving this because you were mentioned.Message ID: @.***>
Quick question, should I directly link to Conventional Commits website upon clicking on this section or should we have a page for this like the rest of the others? Also, is the description good enough? Please have a look at the screenshot below:
I think we should have a page like the others called Commit Style and the file name can be commits.
As to the description we can have:
On EddieHub repos we use Conventional Commits standard. This allows us to create a changelog from the commits.
Within the page it would be good to show some basic examples and then also have the link to the Conventional Commits website.