openedx / openedx/docs.openedx.org
Guideline about "TODO" is ambiguous
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
Adding a TODO in one place requires you to make a pylint fix in another (just to force us to clean up more code).
Please state explicitly whether "TODO" or "FIXME" is discourage and offer a viable alternative for flagging technical debt in the codebase when it cannot be addressed immediately due to time and scope constraints.
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 the linked Python Guidelines page, specifically the Pylint Guidelines and Practices section. Clarify whether TODO or FIXME comments are discouraged and document an alternative for recording technical debt; the work is done when the policy and alternative are explicit in that section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100