quantum-platinum-cloud / smart_todo Goto Github PK

SmartTodo is a library designed to assign users on TODO comments written in your codebase and help assignees be reminded when it's time to commit to their TODO.

1. Add the gem in your Gemfile.

group :development do
  gem 'smart_todo', require: false # No need to require it
end

2. Run bundle install

SmartTodo allows to write TODO comments alongside your code and assign a user to it. When the TODO's event is met (i.e. a certain date is reached), the TODO's assignee will get pinged on Slack.

Without SmartTodo

  # TODO: Warning! We need to change the API endpoint on July 1st because the provider
  # is modifying its API.
  def api_call
  end

With SmartTodo

  # TODO(on: date('2019-07-01'), to: '[email protected]')
  #   The API provider is modifying its endpoint, we need to modify our code.
  def api_call
  end

Please check out the GitHub wiki for documentation and example on how to setup SmartTodo in your project.

This project is licensed under the terms of the MIT license. See the LICENSE file.