Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of the entire codebase #6

Closed
mishraaditya595 opened this issue Jan 15, 2021 · 30 comments · May be fixed by #65
Closed

Documentation of the entire codebase #6

mishraaditya595 opened this issue Jan 15, 2021 · 30 comments · May be fixed by #65
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers GSSOC21

Comments

@mishraaditya595
Copy link
Owner

As one might notice that the codebase for the project has not been documented properly.

@mishraaditya595 mishraaditya595 added DWOC Issue for DevScript Winter Of Code Level2 documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 15, 2021
@Vrushti24
Copy link

I would love to work on this issue but can you elaborate what exactly I have to do??

@mishraaditya595
Copy link
Owner Author

If you go through the code, you will notice that the code has not been documented. So, you have to go through the code, understand what does a function do and document it with the help of comments.

@Vrushti24
Copy link

Vrushti24 commented Jan 18, 2021 via email

@mishraaditya595
Copy link
Owner Author

ok assigning the issue!

@Vrushti24
Copy link

Vrushti24 commented Jan 18, 2021 via email

@mishraaditya595
Copy link
Owner Author

I think 48 hours will be sufficient for documenting it.

@Vrushti24
Copy link

Vrushti24 commented Jan 18, 2021 via email

@Vrushti24
Copy link

Vrushti24 commented Jan 19, 2021 via email

@RuchiGitHu
Copy link

As one might notice that the codebase for the project has not been documented properly.

Good Evening...
Can you please send me the link of github repo for this issue? So that I can check if I am able to resolve this issue.....
Thanks in advance...

@mishraaditya595
Copy link
Owner Author

Check the repo in whose issue's section you have commented.

@RuchiGitHu
Copy link

Thanks..

@deepthiteki
Copy link

Hey @mishraaditya595
Can I work on this issue under GSSOC'21

@mohdjameel2412
Copy link

please assign it to me under gssoc21

@mishraaditya595
Copy link
Owner Author

Hello everyone, glad to see your interest in ScanIt, as there are multiple interested developers, I will try to give chance to everyone on a first-come-first-serve basis. @deepthiteki had approached first so he will be getting the chance. If he does not respond in the next 24 hours, the next in line will be assigned.

@deepthiteki
Copy link

Thank you, sir
I will try to create pr as soon as possible

@mishraaditya595 mishraaditya595 added GSSOC21 and removed DWOC Issue for DevScript Winter Of Code Level2 labels Mar 11, 2021
@shreyadubey0902
Copy link

Hey, I am a participant at GSSoc'21 , I am really interested to contribute to this issue can you assign me?

@deepthiteki deepthiteki removed their assignment Mar 11, 2021
@mishraaditya595
Copy link
Owner Author

Hey @deepthiteki, did you unassign yourself or was it a mistake?

@deepthiteki
Copy link

Hi @mishraaditya595,
I don't have much experience in kotlin so It's taking much longer than I thought and there seems to be a lot of people who are interested and have related skill set.
That's why I unassigned myself.
Sorry

@mishraaditya595
Copy link
Owner Author

Hey @shreyadubey0902, you can start working on it. Keep me informed!

@shreyadubey0902
Copy link

Hey @shreyadubey0902, you can start working on it. Keep me informed!

thankyou @mishraaditya595 Ok I will keep informing it

@amritakesh
Copy link

hello
i'm taking part in gssoc 2021. And i would like work on this issue, will you please assign this to me?

@mishraaditya595
Copy link
Owner Author

mishraaditya595 commented Mar 16, 2021

Hey @shreyadubey0902, It has been 5 days since you have been assigned with this issue and you have not forked the repo yet. Can I know the status? If you do not reply in the next person in line will be assigned.

@simonnepinto
Copy link

Can I work on this issue?

@mishraaditya595
Copy link
Owner Author

Hey @simonnepinto, sorry for the delayed response. You can start working.

@simonnepinto
Copy link

Thanks @mishraaditya595!
For documenting the codebase, I need to add comments (explaining what every function does) in every Kotlin file, right?

@mishraaditya595
Copy link
Owner Author

mishraaditya595 commented Mar 24, 2021

yes. make sure you keep updating your fork with the latest commits.

@simonnepinto
Copy link

Yeah, I will. Thank you.

@mhammadsaani
Copy link

Is this project still active?

@sarahBenzaquen
Copy link

Hi , I'm trying to run the project on my xiaomi but I have errors like "Unable to resolve dependency for ':app@debugUnitTest/compileClasspath': Could not resolve ai.artivatic:cameracontroller:2.0.1."
I'm new on Android , someone could help me please ?

@mishraaditya595
Copy link
Owner Author

Hi @sarahBenzaquen,
Thanks for showing interest in the project. I am not actively maintaining this project anymore. Hence, there might be some issues with the changes in the Android OS framework and the deprecation of APIs. Feel free to fork the project and make your desired changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers GSSOC21
Projects
None yet
Development

Successfully merging a pull request may close this issue.

10 participants