Add code comments to major source files #602
Labels
Projects
Comments
luyangkenneth
moved this from Inbox / Uncategorized
to Goal: Encourage open-source contributions
in Developer Experience Opportunities
luyangkenneth
moved this from Goal: Encourage open-source contributions
to Goal: Reduce technical debt
in Developer Experience Opportunities
luyangkenneth
moved this from Goal: Reduce technical debt
to Goal: Encourage open-source contributions
in Developer Experience Opportunities
luyangkenneth
moved this from Goal: Encourage open-source contributions + Improve contributor experience
to Goal: Reduce technical debt
in Developer Experience Opportunities
|
quite a few now; closing as its a continuing work :-) |
Developer Experience Opportunities
automation
moved this from Goal: Reduce technical debt
to Closed
Dec 13, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Most of the source code is very sparse in comments, with many complex functions left undocumented. This makes it difficult for developers who are new to the project to understand it.
In particular, the
Page.js,Site.js,parser.jsfiles which encapsulate a lot of MarkBind's functionality could be reviewed and comments added.Currently we don't require PRs to include comments. It might be helpful to encourage using simple comments during reviews.
The text was updated successfully, but these errors were encountered: