Skip to content

Latest commit

 

History

History
17 lines (15 loc) · 1.12 KB

TODOs.md

File metadata and controls

17 lines (15 loc) · 1.12 KB
Raw

TODOs

When do we use them?

TODOs should be used sparingly, but are acceptable in the following conditions:

  • To ensure that pull requests are kept small, if there are gaps left in functionality, or stubbed implementations for future pull requests, a TODO comment can be used.
  • When a task you’re working on is depended on by another task, it might make sense to leave empty implementations with a TODO within "hooks" (e.g. button action methods or closures) that will use the functionality introduced in the dependent task.

Key Considerations

  • TODOs must always be accompanied by a link to the task description that will replace the TODO with intended functionality.
  • Do not use FIXME or other specifiers for unfinished work. Sticking with one makes it easier to search for known unfinished work, and makes the decision of which to use easier.
  • TODOs should be specified on single-line and double-slash comments only.

Example

@objc private func editButtonTapped(_ sender: UIButton) {
    // TODO: Display the editing UI once it’s complete: https://github.com/Lickability/Scorecard/issues/4
}