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

Comments #20

Open
hdrdavies opened this issue Oct 23, 2015 · 3 comments
Open

Comments #20

hdrdavies opened this issue Oct 23, 2015 · 3 comments

Comments

@hdrdavies
Copy link

Just a quick note - there's quite a lot of comments throughout your files.

Would you consider cleaning these up every time you push?

Comments should be reserved for when there's kind of random stuff in your code that can't be explained by well-named functions and readable code.

@Joshua-Ronan-Phillips
Copy link
Member

we definitely should clean up a lot of our comments so thank you for that. I think having any comments at all can be more of a subjective call. especially at this stage in our learning where we will benefit even more from added comments.

@mantagen
Copy link
Contributor

Let's deal with this during code review
@Joshua-Ronan-Phillips
@katpas
@katkelemen

@hdrdavies
Copy link
Author

Yeah you're right Josh. When working as a team at the moment if there's something you want to remind yourself of, do go ahead and comment it. Same goes for things that aren't massively clear.

However if it's just commented out console.logs, as well as commented out tests and functions etc. just get rid of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants