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 documentation #8

Open
4 tasks done
kashish-ag opened this issue Jun 10, 2021 · 15 comments
Open
4 tasks done

Add documentation #8

kashish-ag opened this issue Jun 10, 2021 · 15 comments
Assignees
Labels
good first issue This issue is good for first timers 🟩 Level1 This issue will be considered as level 1 issue for LGM-SOC 21.Points will be 5 LGMSOC21 This issue will be considered for LGM-SOC 21

Comments

@kashish-ag
Copy link
Owner

kashish-ag commented Jun 10, 2021

Objective of this issue will be:

  • Update readme.md
  • Add comments to the code
  • Add docstrings
  • Add cool graphics/output snapshots to the readme.

You can pick up one or all the issues.

@kashish-ag kashish-ag added good first issue This issue is good for first timers 🤩 Up for Grab This issue will is not assigned ! Grab It ! 🟩 Level1 This issue will be considered as level 1 issue for LGM-SOC 21.Points will be 5 LGMSOC21 This issue will be considered for LGM-SOC 21 labels Jun 10, 2021
@Abhinavs476
Copy link

I would like to work on updating readme by adding snippets and graphics and adding necessary comments to the code. So I request you to assign this issue to me.

@kashish-ag
Copy link
Owner Author

Sure!

@nekkantimadhu
Copy link
Contributor

I would like to contribute on this issue under LGM SOC 21, Could you please assign this issue to me?

@kashish-ag
Copy link
Owner Author

Sure :)

@kashish-ag kashish-ag removed the 🤩 Up for Grab This issue will is not assigned ! Grab It ! label Jun 12, 2021
@Ayan-thecodeking
Copy link
Contributor

hey @kashish-ag please assign me if something is left in readme
i'll do that :)

@kashish-ag
Copy link
Owner Author

You can give me ideas if you have some Ayan and I'll assign that to you.

@Baba-Yaga-1
Copy link
Contributor

Baba-Yaga-1 commented Jun 14, 2021

Hey @kashish-ag, I would like to work on this issue by updating the README.md file with the contributors and also the Code of Conduct. Can you assign it to me ?

@kashish-ag
Copy link
Owner Author

Okay Liza I'm opening another issue for the same. Can you please comment there and I'll assign it.

@Baba-Yaga-1
Copy link
Contributor

okay, sure

@Ayan-thecodeking
Copy link
Contributor

Ayan-thecodeking commented Jun 14, 2021

You can give me ideas if you have some Ayan and I'll assign that to you.

hey @kashish-ag i have also asked for same thing ...that liza has asked but i haven't described becoz i hv seen 2 more peoples already assigned....thats a reason i just asked to assign if something is left ..
but now u hv given this to liza , is that good
becoz i have asked first

@kashish-ag
Copy link
Owner Author

Hey @Ayan-thecodeking, Liza gave me the idea of what she wanted to do and I assigned that to her and that's totally fair. If you won't describe the work how can you expect me to understand. Liza described to me what she wanted to do and that's what the thing I asked you for because according to my knowledge there's nothing left. If you still have some ideas you can tell me and in case of more queries comment below. Thank you!

@bhavesh-jo
Copy link

@kashish-ag what kind of updates need to be done ? kindly tell and assign

@kashish-ag
Copy link
Owner Author

@Wittty-Panda It's done already!

@Komal-99
Copy link
Contributor

Komal-99 commented Jul 3, 2021

Hi i would like update the readme ! with making plants list in a tabular form as 38 points make readme a bit long and to add some screenshots like for fork button and some editing in markdown .
If you like the idea kindly assign it to me

@kashish-ag
Copy link
Owner Author

Hey @Komal-99, yeah sure please do that. I am creating a separate issue please comment there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue This issue is good for first timers 🟩 Level1 This issue will be considered as level 1 issue for LGM-SOC 21.Points will be 5 LGMSOC21 This issue will be considered for LGM-SOC 21
Projects
None yet
Development

No branches or pull requests

7 participants