Add tags to your code with predefined templates
TODO: (MILESTONE, MLSTN, DONE, YAGNI, TBD, TOBEDONE)
To do:Informal tasks/features that are pending completion.
FIXME: (XXX, DEBUG, BROKEN, REFACTOR, REFACT, RFCTR, OOPS, SMELL, NEEDSWORK, INSPECT)
Fix me: Areas of problematic or ugly code needing refactoring or cleanup.
Bugs: Reported defects tracked in bug database.
Ideas: Possible RFE candidates, but less formal than RFE.
WTF: (WTF, QUEST, QSTN, QUESTION)
Questions: Misunderstood details.
HACK: (CLEVER, MAGIC)
Hacks: Temporary code to force inflexible functionality, or simply a test change, or workaround a known problem.
Notes: Sections where a code reviewer found something that needs discussion or further investigation.
SEE: (REF, REFERENCE)
See: Pointers to other code, web link, etc.
NOBUG: (NOFIX, WONTFIX, DONTFIX, NEVERFIX, UNFIXABLE, CANTFIX)
Will Not Be Fixed: Problems that are well-known but will never be addressed due to design problems or domain limitations.
REQ: (REQUIREMENT, STORY)
Requirements: Satisfactions of specific, formal requirements.
RFE: (FEETCH, NYI, FR, FTRQ, FTR)
Requests For Enhancement: Roadmap items not yet implemented.
Alerts: In need of immediate attention.
PORT: (PORTABILITY, WKRD)
Portability: Workarounds specific to OS, language version, etc.
CAVEAT: (CAV, CAVT, WARNING, CAUTION)
Caveats: Implementation details/gotchas that stand out as non-intuitive.
Frequently Asked Questions: Interesting areas that require external explanation.
Glossary: Definitions for project glossary.
TODOC: (DOCDO, DODOC, NEEDSDOC, EXPLAIN, DOCUMENT)
Needs Documentation: Areas of code that still need to be documented.
CRED: (CREDIT, THANKS)
Credits: Accreditations for external provision of enlightenment.
Status: File-level statistical indicator of maturity of this file.
RVD: (REVIEWED, REVIEW)
Reviewed: File-level indicator that review was conducted.
log them in the github issues or hit me on twitter.
:star: this repo.