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

Add Comments to a file in a module explaining what the code is doing. Multiple Users can assign this. #125

Open
Tc2r1 opened this issue Oct 22, 2022 · 13 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Tc2r1
Copy link
Owner

Tc2r1 commented Oct 22, 2022

This one is simple, Inside the project, find a file/class and add comments to the code to help explain what users are doing.

@Tc2r1 Tc2r1 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest labels Oct 22, 2022
@mksiddiq
Copy link
Contributor

mksiddiq commented Oct 22, 2022

I can do this. I am a beginner, so it will also help me learn.

!assign

@github-actions
Copy link

👋 You've been assigned this issue, Please fork the repository and create a branch to work on the issue assigned here 💻. When you are done make a Pull Request. Good Luck!

@Tc2r1 Tc2r1 changed the title Add Comments to a file in a module explaining what the code is doing. Add Comments to a file in a module explaining what the code is doing. Multiple Users can assign this. Oct 22, 2022
@Vaishnavi-More
Copy link

Hey @Tc2r1 kindly assign this issue to me. I am beginner and I want to learn something new and I can do this.

@Tc2r1
Copy link
Owner Author

Tc2r1 commented Oct 22, 2022

You can assign the file to yourself, instructions are in the root readme. @Vaishnavi-More

However after reviewing your github and linked it I think you're doing yourself a disservice to set the bar so low, surely you could add something to the repo :) There are some pretty simple issues (like add a splash screen to the app) if you're interested. GDSC is an awesome idea but if all you're gonna do is commit low tier PRs (such as copy paste algorithms in those "Begginer friendly repository for hacktoberfest 2022") I think you're doing yourself a disservice and missing the point of Hacktoberfest.

What I'm trying to say Is I believe you can do way better, ps nice articles.

Regardless of my thoughts, feel free to contribute to whichever issue you want, if you do seek to add some code, I'm here to respond and help if you need.

@Vaishnavi-More
Copy link

Hey @Tc2r1 , actually I am a beginner and I have very little knowledge about open source. And I am not trying to copy paste code but all the contributions made by me are my own documents. All the codes contributed are written by me and I have studied them earlier. And I would like to request you to kindly guide me so that I don't break the rule.
It would help me allot.

@Tc2r1
Copy link
Owner Author

Tc2r1 commented Oct 22, 2022

@Vaishnavi-More You want to be careful not to contribute too much to repositories that break this rule or you can end up blacklisted from the fest.

https://user-images.githubusercontent.com/43691873/135965000-a3019b12-c089-4a61-bae3-81f915ec39a5.png

To find good repos to contribute to, these sites are very useful for small contributions:

https://up-for-grabs.net/#/filters?tags=android
https://www.firsttimersonly.com/
https://goodfirstissues.com/
https://goodfirstissues.dev/
https://gitlab.com/explore/projects/topics/hacktoberfest

Besides my repo, which my brother and I are super active in helping (we want to give back!)

Here are some we've found recently that might be good for an android developer.

https://github.com/gouravkhunger/QuotesApp

https://github.com/ritwikshanker/GoCoronaGo/issues

https://github.com/mlscvitpune/Development-App/issues

https://github.com/BrightID/BrightID

https://github.com/viveeeeeek/1stHacktoberfest

https://github.com/PEC-CSS/MovieDroid

https://github.com/szabgab/awesome-for-non-programmers

https://github.com/xxxcucus/planes/issues

https://github.com/ankidroid/Anki-Android/issues

Remember you can just grab the repo, compile the project and look for things to fix (such as add comments, fix typos, update dependency libraries, etc)

Hope this is helpful. @Vaishnavi-More

@Vaishnavi-More
Copy link

Thank you so much!
It is really helpful and would guide me!

@github-actions
Copy link

👋 You've been assigned this issue, Please fork the repository and create a branch to work on the issue assigned here 💻. When you are done make a Pull Request. Good Luck!

@ShireanR
Copy link

!assign

Hi please can I be assigned to this too.

@github-actions
Copy link

👋 You've been assigned this issue, Please fork the repository and create a branch to work on the issue assigned here 💻. When you are done make a Pull Request. Good Luck!

@komalsoni4
Copy link

please assign me

@Tc2r1
Copy link
Owner Author

Tc2r1 commented Oct 26, 2022

@komalsoni4 please read the readme.md to see how to assign yourself an issue.

Repository owner deleted a comment from komalsoni4 Oct 26, 2022
@github-actions
Copy link

👋 You've been assigned this issue, Please fork the repository and create a branch to work on the issue assigned here 💻. When you are done make a Pull Request. Good Luck!

Repository owner deleted a comment from komalsoni4 Oct 26, 2022
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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants