Better documentation

[fidergo-stephane-gourichon]

Hello,

Found plugin on Feature #1176: Recurring Tasks - Redmine - comment 78. Kudos for your effort.

The README.md does not tell anything about the actual features. I tried to install it but some step fails.

Using vocabulary from Feature #1176: Recurring Tasks - Redmine - comment 46, what does it do to a recurring issue ?

• "resurrect" ("reopen" would be more in line with usual vocabulary) by changing status and due date
• or "recreate" by duplicating issue
• or is it configurable ?

Looking at the code at https://github.com/nutso/redmine-plugin-recurring-tasks/blob/master/app/models/recurring_task.rb I only see code that looks like it does the "recreate/duplicate" style.

  new_issue = issue.copy
  new_issue.due_date = previous_date_for_recurrence + recurrence_pattern
  new_issue.start_date = new_issue.due_date
  new_issue.done_ratio = 0
  new_issue.status = IssueStatus.default # issue status is NOT automatically new, default is whatever the default status for new issues is
  new_issue.save!

This certainly fits some use cases (rare issues or issues that need discussion every time) but it does not fit simple cases of high frequency issues (weekly, monthly) where all comments (if any at all) should be kept in a single thread. -- I happen to only need the "reopen" style.

Have I figured it out right or have I missed that this plugin indeed can work with a "reopen" style ?

In any case updating README.md with one or two sentence about what the plugin does would be very good.

Thanks!

[nutso]

Hello,

The plugin only creates new issues, leaving previous issues as 'related' but separate. I added this as an option to develop.

This will not let you search for items in Redmine for a history of deadlines for example, but I see the point about the comments.

[sgourichon]

Thanks for incorporating in "list of features requested" and updating README.md. It's much clearer now about what the plugin currently does. Cheers.