ui
ui copied to clipboard
go-vela
docs: add comments to refactored ui
awesome work! love it. though i believe it needs another pass, i made it about halfway through reviewing, left some feedback, and plan on making it through the rest, thank you!
Could we possibly add descriptions above the functions in Main.elm, since it's such a large file and is the core file? Or do we think it's not necessary?
@wsan3 With the way elm-land works, there isn't a Main.elm that is committed to source control; it is generated during deployment. We have some unique requirements which don't play nicely with Elm-Land. Therefore, for now, we now maintain a fork for the elm-land cli and some background is in https://github.com/go-vela/ui/pull/781, and we elected to have Main.elm pushed to source control.
We also decided to not comment certain files, as they would fall under that umbrella of being auto-generated. They are mostly the top level .elm files, and certain content under /Pages. However, most of /Pages was commented for now, but might be backed out in the future, or not enforced.