search

antrikshmisri / Github-Automation

Github automation with clean frontend
6 stars 7 forks source link

Add documentation for all `functions`/`classes` #6

Open antrikshmisri opened 2 years ago

antrikshmisri commented 2 years ago

Is your feature request related to a problem? Please describe. The python scripts (src/scripts) lack proper documentation which may include proper docstrings, descriptive variable names etc. Also the codebase needs proper formatting overall

Describe the solution you'd like Add these docstrings as well as format the codebase

soma2000-lang commented 2 years ago

@antrikshmisri I would like to work on this issue.I am an SWOC prticiapnt

kkg2001 commented 2 years ago

I wish to contribute to this project frontend or backend anything is fine. Also I want to add something to this,for the comfort of user we can add audio feature(if possible) by which user will only have to say the command and the system will listen to it and execute. Also if there is a typo error from user's end the system should understand and rectify and execute it further.

SWOC21

antrikshmisri commented 2 years ago

@antrikshmisri I would like to work on this issue.I am an SWOC prticiapnt

Hey @soma2000-lang, sure you can start to work on this issue as soon as everything is sorted and the contribution period officially starts.

antrikshmisri commented 2 years ago

I wish to contribute to this project frontend or backend anything is fine. Also I want to add something to this,for the comfort of user we can add audio feature(if possible) by which user will only have to say the command and the system will listen to it and execute. Also if there is a typo error from user's end the system should understand and rectify and execute it further. #SWOC21

Hey @kkg2001, I appreciate the ideas but I don't think this is something that the app needs as of now. If you wish you can work on some other issues (will add some more issues soon). If you find some other bug in the codebase feel free to add an issue, the same applies to a feature request.

soma2000-lang commented 2 years ago

@antrikshmisri I would like to work on this issue.I am an SWOC prticiapnt

Hey @soma2000-lang, sure you can start to work on this issue as soon as everything is sorted and the contribution period officially starts.

ok.