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.

Sign up for GitHub

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

Jump to bottom

Add documentation #2

Open
1 of 3 tasks
akshitadixit opened this issue Jun 10, 2021 · 10 comments
Open
1 of 3 tasks

Add documentation #2

akshitadixit opened this issue Jun 10, 2021 · 10 comments
Assignees
@Itashamodi @Sidhved @jayant766 @KishkinJ10
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

@akshitadixit
Copy link
Owner

akshitadixit commented Jun 10, 2021 •
edited
Loading

The current code contains minimalistic documentation that too at only some places. Objective of this issue will be:

  • Improve readme instructions
  • Add comments in code
  • Add docstrings for functions that might need elaborate commenting

You are free to pick up any or all of the above 3 sub-tasks.
For any assistance, feel free to reply to this.
@akshitadixit akshitadixit added good first issue This issue is good for first timers LGM-SOC labels Jun 10, 2021
@akshitadixit akshitadixit mentioned this issue Jun 10, 2021
Closed
@jayant766
Copy link
Contributor

Please assign me this issue under LGMSOC'21

@akshitadixit akshitadixit added LGMSOC21 This issue will be considered for LGM-SOC 21 🟩 Level1 This issue will be considered as level 1 issue for LGM-SOC 21.Points will be 5 and removed LGM-SOC labels Jun 10, 2021
@akshitadixit
Copy link
Owner Author

Sure @jayant766 :)

@KishkinJ10
Copy link

can I also work on this? I am LGM-SOC 21 participant

@akshitadixit
Copy link
Owner Author

@jayant766 please let us know your progress, we have somebody who would like to share your work :)

And @KishkinJ10 let's wait till EOD until Jayant replies just to give him a fair chance, after which I'll assign the issue to you.

@jayant766
Copy link
Contributor

@akshitadixit I am working on it. Please don't assign it to anyone till tomorrow evening. If anyone wants to collaborate with me I am ready.

@akshitadixit
Copy link
Owner Author

@jayant766 sure

Meanwhile @KishkinJ10 you can connect with Jayant over slack to collaborate and make PRs for different files if you wish.

@Itashamodi
Copy link

assign me

@KishkinJ10 KishkinJ10 mentioned this issue Jun 12, 2021
Closed
@akshitadixit
Copy link
Owner Author

@Itashamodi sure

@Sidhved
Copy link
Contributor

Sidhved commented Jun 12, 2021

Can this one be assigned to me under LGMSOC'21? I'll like to collaborate with other participants and help with documentation process

@akshitadixit
Copy link
Owner Author

@Sidhved sure reach out to them on slack

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Itashamodi Itashamodi

@Sidhved Sidhved

@jayant766 jayant766

@KishkinJ10 KishkinJ10

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
Milestone
No milestone
Development

No branches or pull requests
5 participants
@akshitadixit @Itashamodi @Sidhved @jayant766 @KishkinJ10