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

Chore: Adding comments to the code #317

Closed
LuchoTurtle opened this issue Feb 23, 2023 · 1 comment · Fixed by #318
Closed

Chore: Adding comments to the code #317

LuchoTurtle opened this issue Feb 23, 2023 · 1 comment · Fixed by #318
Assignees
Labels
chore a tedious but necessary task often paying technical debt documentation Improvements or additions to documentation enhancement New feature or enhancement of existing functionality flutter Flutter related issues

Comments

@LuchoTurtle
Copy link
Member

as noted in #314 (comment)

The added code has no comments. They should be added so newcomers understand what it does better.

@LuchoTurtle LuchoTurtle added enhancement New feature or enhancement of existing functionality chore a tedious but necessary task often paying technical debt flutter Flutter related issues documentation Improvements or additions to documentation labels Feb 23, 2023
@LuchoTurtle LuchoTurtle self-assigned this Feb 23, 2023
@LuchoTurtle LuchoTurtle moved this to 🏗 In progress in dwyl app kanban Feb 23, 2023
LuchoTurtle added a commit that referenced this issue Feb 23, 2023
@LuchoTurtle LuchoTurtle moved this from 🏗 In progress to ⏳Awaiting Review in dwyl app kanban Feb 23, 2023
@nelsonic
Copy link
Member

Retrospectively adding comments to code - and only when requested -
is like doing homework after the deadline.
At best it's a "C" for effort.
If you want to be an "A+ Player", make it as easy as possible
for everyone in your team to pick-up the code you write and maintain/extend it.

It might feel arbitrary to add comments.
But for future reference: all code MUST be documented
as if you actually want someone to understand it the first time they read it
without having to waste time Googling for any part of it.

You won't have felt the pain of inheriting a codebase without tests or detailed comments.
And for your sake I hope you never have suffer that pain.

"Always code as if the person who ends up maintaining your code
will be a violent psychopath who knows where you live.
"
~ John Woods

@github-project-automation github-project-automation bot moved this from ⏳Awaiting Review to ✅ Done in dwyl app kanban Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore a tedious but necessary task often paying technical debt documentation Improvements or additions to documentation enhancement New feature or enhancement of existing functionality flutter Flutter related issues
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants