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

Making code-base contain more comments #1046

Closed
Divy123 opened this issue Apr 27, 2019 · 25 comments
Closed

Making code-base contain more comments #1046

Divy123 opened this issue Apr 27, 2019 · 25 comments
Labels
gci-candidate Issue being considered for gci hall-of-fame

Comments

@Divy123
Copy link
Member

Divy123 commented Apr 27, 2019 •
edited by debck
Loading

Note: We are preparing to participate in Google Code-in, and have reserved this issue for participants in GCI - but we'd love to have your help with another one! Please check out https://code.publiclab.org to see more.

We can add more and more comments to the existing code base for making it more and more new contributors friendly.

This issue requires adding more comments to various files under lib folder which are mainly related to UI.
@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Apr 27, 2019 •
edited
Loading

Great, we can add JSDOC comments

/**
* @method methodName
* @param {Boolean} bool
* @returns {Boolean}
*/
function  returnBool(bool) {
  return bool
}

@harshkhandeparkar
Copy link
Member

See PR #1038 for examples

@harshkhandeparkar harshkhandeparkar added the gci-candidate Issue being considered for gci label Oct 28, 2019
@Divy123 Divy123 added the medium label Nov 29, 2019
@publiclab publiclab deleted a comment from harshkhandeparkar Nov 29, 2019
@Divy123 Divy123 closed this as completed Nov 29, 2019
@Divy123 Divy123 reopened this Nov 29, 2019
@Divy123
Copy link
Member Author

Divy123 commented Nov 29, 2019

uploaded this on gci dashboard.

@SidharthBansal
Copy link
Member

Published on GCI dashboard!

@harshkhandeparkar
Copy link
Member

I have claimed this task on the GCI dashboard.

@harshkhandeparkar harshkhandeparkar mentioned this issue Dec 7, 2019
Closed
5 tasks
@SidharthBansal
Copy link
Member

SidharthBansal commented Dec 7, 2019 via email

@SidharthBansal
Copy link
Member

@harshkhandeparkar please break it up into discrete issues of interrelated files and inter-related PRs.
Work is interrelated so each issue + pr together will be of 3 points.
I don't want anyone will get just 3 points for so many changes in so many files.

Each PR should contain at least 15 lines. If that file contains a lesser number of lines, then we can add two files in one PR. Does this make sense?

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 9, 2019 via email

@SidharthBansal
Copy link
Member

SidharthBansal commented Dec 9, 2019 via email

This was referenced Dec 9, 2019
Closed
Closed
Closed
Closed
Closed
@SidharthBansal
Copy link
Member

I have changed it into hall of fame task.

@SidharthBansal
Copy link
Member

Please don't write documentation for other files, as we will not be able to give you points for them more than 15.
So stick to 13 files which you touched ONLY
thanks
Sidharth

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 9, 2019 via email

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 9, 2019 via email

@SidharthBansal
Copy link
Member

Let's first complete 13 files which you touched and all related issues of this main issue
Thanks

@SidharthBansal
Copy link
Member

Regarding work, I have to confirm with @jywarren. May be you have to do more than 13 files documentation as it is changed to hall-of-fame

@SidharthBansal
Copy link
Member

Atleast 15 files should be documented as per my thinking.
Rest dependends on Jeff's decision

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 9, 2019 via email

@SidharthBansal
Copy link
Member

SidharthBansal commented Dec 9, 2019 •
edited
Loading

I have exam tomorrow. Complete documentation of some other tasks too in the meantime.
THanks

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 9, 2019 via email

@SidharthBansal
Copy link
Member

You said that we need to add documentation to other tasks too. Can you please start working on those files too.

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 9, 2019 via email

@SidharthBansal
Copy link
Member

SidharthBansal commented Dec 9, 2019 via email

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 9, 2019 via email

@harshkhandeparkar harshkhandeparkar mentioned this issue Dec 10, 2019
Closed
@SidharthBansal
Copy link
Member

Shall we close this?

@harshkhandeparkar
Copy link
Member

Yeah, I guess...

@harshkhandeparkar harshkhandeparkar removed gci-candidate Issue being considered for gci hall-of-fame labels Jan 17, 2020
@harshkhandeparkar harshkhandeparkar added gci-candidate Issue being considered for gci hall-of-fame labels Jan 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
gci-candidate Issue being considered for gci hall-of-fame
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[GCI]Added More Comments to the Codebase
3 participants
@SidharthBansal @Divy123 @harshkhandeparkar