MacDownApp / MacDownApp/macdown
Address scattered TODO/FIXME comments throughout codebase
Nobody has claimed this yet.
- Dominant language
- Rich Text Format
- Stars
- 9.8k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
Summary
Multiple TODO and FIXME comments are dispersed across the repository, particularly in:
- Dependency/prism components (e.g., prism-wiki.js, prism-rust.js, prism-pascal.js, prism-perl.js, prism-haml.js, prism-smarty.js)
- MacDown Resources/Prism components (same languages)
- peg-markdown-highlight/HGMarkdownHighlighter.m (todo: throw exception if targetTextView is nil?)
- Dependency/YAML-framework/YAMLSerialization.m (several TODO/FIXME comments)
These comments indicate incomplete implementations, missing error handling, or planned enhancements that should be tracked and resolved.
Suggested Actions
- Categorize each TODO/FIXME by severity and component.
- Create sub-tasks or individual issues for each pending item.
- Assign owners and set target milestones for completion.
- Remove or document the TODOs once the associated work is done.
Example Items
- in several prism components – ensure multi-line support is implemented.
- – evaluate and implement if needed.
- – verify against YAML spec and implement validation.
- – add nil-check and appropriate exception handling.
This issue tracks the overall effort to clean up the TODO/FIXME backlog across the codebase.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with a repository-wide search for TODO and FIXME comments, focusing on the listed Prism files, peg-markdown-highlight/HGMarkdownHighlighter.m, and Dependency/YAML-framework/YAMLSerialization.m. Categorize each item by component and severity, then track actionable work as sub-issues; done means pending items are resolved or documented with ownership and milestones.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, objective-c
- Domain
- desktop, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100