search

creativecommons / quantifying

quantify the size and diversity of the commons--the collection of works that are openly licensed or in the public domain
MIT License
23 stars 31 forks source link

Improving Comments in codebase #49

Closed NEGRAH-S closed 6 months ago

NEGRAH-S commented 1 year ago

Problem

The code lacks the comments that would help it be easier to read.

Description

Adding suitable comments in the codebase

Additional context

Comment serve as a reminder to change something in the future. Code commenting also becomes invaluable when you want to ‘comment out’ code. This is when you turn a block of code into a comment because you don’t want that code to be run, but you still want to keep it on hand in case you want to re-add it.

Implementation

devAdityaa commented 1 year ago

@NEGRAH-S Hello, I also find that there is a lack of comments in the code. I'll fix this. Can you assign this issue to me?

satyampsoni commented 1 year ago

If you need any help on this. Pls let me know I'll be happy to collaborate.

TimidRobot commented 1 year ago

The indentation is largely controlled by the static analysis tools.

Also see #53

(issue description updated to remove indentation as a concern)

NEGRAH-S commented 1 year ago

Thanks Sir @TimidRobot for mentioning the details.

jai12789 commented 7 months ago

Hi @TimidRobot . I would like to work on this issue. Can you assign this to me?

TimidRobot commented 7 months ago

@jai12789 Please see Contribution Guidelines — Creative Commons Open Source for how we manage issues and PRs (we generally don't assign issues prior to resolution).

PawarVedant123 commented 7 months ago

i am interested in fixing this issue

Paulooh007 commented 7 months ago

i am interested in fixing this issue

How this normally works is, first you create a PR for this issue then the PR is reviewed by @TimidRobot or any other contributor, and then it will be assigned to you. So for the issue to be assigned to you, your PR must be open and active.

NEGRAH-S commented 7 months ago

@PawarVedant123 rightly guided by @Paulooh007. This is how we work on issue at CC for any assistance read https://opensource.creativecommons.org/contributing-code/ . That would most solve all your query.

TimidRobot commented 6 months ago

@nox1134 please comment on this issue so I can assign it to you

nox1134 commented 6 months ago

Hi @TimidRobot ! Please assign this issue to me so that I can add comments in the other files.