Better communicate the refactor plan surrounding boards
groupproduct planning is currently refactoring various parts of boards (boards store and sidebar) as swimlanes and graphql are introduced.
Both the refactor and addition of swimlanes have been incrementally done in the existing code files (e.g., boards/index.js
, boards/_show.html.haml
) and it isn't always immediately clear which part is being deprecated and refactored to those unfamiliar with the boards code.
For example, this question came up during a maintainer review for !45490 (merged). The author (@euko) of the MR should've pre-emptively provided some context to the maintainer!
question: @euko it looks like we're also setting
timeTrackingLimitToHours
in the store a few lines above? I'm a little concerned that we're losing a single source of truth for this. Do we not have access to theboardsStore
inboard_sidebar_time_tracker.vue
?
With this said, to allow reviewers and other engineers who stumble on boards to be more efficient, 1) we should add more comments like the one found in boards_list.vue:
// This component is being replaced in favor of './board_list_new.vue' for GraphQL boards
and 2) if possible, consider spinning off the refactored parts from the existing files.