Sha256: 193a0fee33a39f4767f2c530fc4e392835983972277bd7f4bd740e2f6b9eb2cd
Contents?: true
Size: 1.51 KB
Versions: 9
Compression:
Stored size: 1.51 KB
Contents
<h3 align="center">
<img src="https://user-images.githubusercontent.com/8122246/61341925-b936d180-a848-11e9-95c1-0d2f398c51b1.png?raw=true" width="200">
</h3>
[](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: 'john@example.com')
# 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.
Version data entries
9 entries across 9 versions & 1 rubygems