https://github.com/Shopify/smart_todo

Enhance TODO comment in your Ruby code
https://github.com/Shopify/smart_todo

slack task-management todo tools

Last synced: about 2 months ago
JSON representation

Enhance TODO comment in your Ruby code

• Host: GitHub
• URL: https://github.com/Shopify/smart_todo
• Owner: Shopify
• License: mit
• Created: 2019-07-04T23:56:23.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T16:23:53.000Z (3 months ago)
• Last Synced: 2024-10-31T15:17:00.811Z (3 months ago)
• Topics: slack, task-management, todo, tools
• Language: Ruby
• Homepage:
• Size: 219 KB
• Stars: 145
• Watchers: 349
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  



[![Build Status](https://github.com/Shopify/smart_todo/workflows/CI/badge.svg)](https://github.com/Shopify/smart_todo/actions?query=workflow%3ACI)

_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.

Installation

-----------

1) Add the gem in your Gemfile.

```ruby

group :development do

  gem 'smart_todo', require: false # No need to require it

end

```

2) Run `bundle install`

Summary

---------

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**

```ruby

  # 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**

```ruby

  # 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

```

Documentation

----------------

Please check out the GitHub [wiki](https://github.com/Shopify/smart_todo/wiki) for documentation and example on how to setup SmartTodo in your project.

License

--------

This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE.txt) file.