naholyr/github-todos

Synchronize issues and TODOs both ways

Open

#9 opened on Nov 12, 2014

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (1,290 stars) (44 forks)batch import
enhancementhelp wantedquestion

Description

For discussion, let's study possibilities:

  • Closing issue when a TODO is removed or "marked as complete"?
  • Remove TODOs when issue is closed?
  • Do it automatically? At push-time? In a separate command (brew doctor-like)?

Contributor guide

Tech stack
javascriptshell
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Understanding of git hooksFamiliarity with GitHub APIBasic JavaScript knowledgeKnowledge of issue tracking workflows
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
This issue discusses potential approaches for two way synchronization between TODOs in code and GitHub issues. It proposes several possibilities: closing issues when TODOs are removed, removing TODOs when issues are closed, and automating this process at push time or via a separate command. To move forward, a newcomer should review the existing codebase in https://github.com/naholyr/github todos to understand how TODOs are currently parsed and converted to issues. Then, they should engage in the discussion to clarify the preferred approach and design a concrete implementation plan. The issue has been stale since 2014, so gaining maintainer input on requirements is essential.