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: 7 days 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 (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T08:39:52.000Z (21 days ago)
- Last Synced: 2025-04-07T04:15:11.393Z (15 days ago)
- Topics: slack, task-management, todo, tools
- Language: Ruby
- Homepage:
- Size: 250 KB
- Stars: 154
- Watchers: 351
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](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.