styleguide-todo-grammar
styleguide-todo-grammar copied to clipboard
/sBin/StyleGuide/ToDo
Available Grammar
@TODO: Something to be done@FIXME: Bug Report, should be corrected, Marked with :bug: Commit@CHANGED: Version Changes together with@SINCEDocComment, Usually Marked with :fire: or :zap: Commits@XXX: Warn other programmers of problematic or misguiding code@IDEA: A New Idea or Proof-of-Concept, Marked with :bulb: Commit@HACK: Workaround or Customer Customizations, Marked with :ribbon: Commit@NOTE: Add attention to something Important@REVIEW: Needs to be Audited/Reviewed Immediately, Usually Marked with :construction: Commit
Bug Report
- Add
@FIXMEComment above SourceCode where Bug/Exception was Occurred. - Write Additional Information:
- Steps to Reproduce the Error
ExceptionMessage and Code- Expected Result
- Actual Result
- Environment Detail
- Mention the Task ID in Format
{T###}. - (optional) Add Screenshots in Format
{F###}(Phabricator Specific). - Commit the Comments(with :bug: Emoji), also include Items 2.B, 3 & 4 in Commit Message too.
- Award that Task with
Manufacturing DefectToken(Phabricator Specific).
Notes
- Do NOT edit Contents of
Vendorfiles(Composer, Bower, ...). - Grammars Should Appear in a List/Window in Your IDE of Choice(PHPStorm).
- There Must be an Audit for this Bug(Commit) Appear in Phabricator.
- These Kind of Bug Reports Remain in History of VCS for future References of that Scope of Code.
- All Attached Files & Commit Reference HashTag will be Referenced in the Phabricator Task View.
- These Audits May become Tasks Later.
References
- https://en.wikipedia.org/wiki/Comment_(computer_programming)#Tags
- https://softwareengineering.stackexchange.com/questions/65467/what-does-xxx-mean-in-a-comment