Todos to task lists

[thejoeejoee]

This issue was automatically created by a github action that converts project Todos to issues.

This issue is automatically created by Unittests. If this issue is not automatically closed, tests have failed.

https://github.com/kevinsawade/python-todo-to-issue/blob/036ef2ca/main.py#L47

# This is the code block that would normally be attached to the issue.
def function()
    return 'Hi!'

[kevinsawade]

Hello Josef! I see, you have forked my repo. If there's anything I can help you with, just let me know. I would be more than happy to help.

[thejoeejoee]

Hi @kevinsawade!

Firstly, thank you for the project, and sorry for the spam, wasn't expecting that running tests would post issues, but that's the meaning of your repository, so. :smile:

Well, I was searching for GH Actions to submit our TODOs to GH, but no repository offers to collect TODOs into one single issue. Why? Because issue task lists are pretty useful, it would be kinda easier to have them instead of a long list of issues (so we can select, which TODO should be an issue). Bellow example of expecting issue content.

I am not expecting you to make it, I can make it by myself -- but PR wouldn't be a problem if you'd be interested.

Project TODOs

Active

• [ ] tests/after_code_todos.py:1 self.is_recursive = False: will need to be a 2nd pass as creation of all files is not complete
• [ ] tests/after_code_todos.py:5 for now ignoring anything after the filename

  Completed

• [x] tests/foobar.py:25 for now ignoring anything after the filename
• [x] #107

[kevinsawade]

Interesting idea. :)

Normally adding milestones to an issue (I know, that the milestone feature is currently not working in my repo >.<) adds them to a large list of issues (https://github.com/kevinsawade/python-todo-to-issue/milestone/1) and displays a progress bar for this milestone based on the number of completed issues.

A possible approach besides adding a milestone to Todos (issues) could be collecting the small single line todos (e.g.:

def myfunc(*args):
    """A function

    Todo:
        * Write the function.

    """
    # todo: write a return
    pass

in an issue with a task list containing these todos:

• [ ] Write the function.
• [ ] write a return

This could be done on a per-file basis or for the whole project. This would also reduce the issue spam :)

Multi-line todos currently create the issue header from the first line of the todo. Here, it would be harder to put them into task lists (maybe make the header bold?):

def myfunc2(*args):
    """A function

    Todo:
        * This is the header of the issue.
            The following text is indented according
            to google styled docstrings.

    """
    pass

creates:

• [ ] This is the header for the issue: The following text is indented according to google styled docstrings.