@TODO
: Something to be done@FIXME
: Bug Report, should be corrected, Marked with π Commit@CHANGED
: Version Changes together with@SINCE
DocComment, Usually Marked with π₯ or β‘ Commits@XXX
: Warn other programmers of problematic or misguiding code@IDEA
: A New Idea or Proof-of-Concept, Marked with π‘ Commit@HACK
: Workaround or Customer Customizations, Marked with π Commit@NOTE
: Add attention to something Important@REVIEW
: Needs to be Audited/Reviewed Immediately, Usually Marked with π§ Commit
- Add
@FIXME
Comment above SourceCode where Bug/Exception was Occurred. - Write Additional Information:
- Steps to Reproduce the Error
Exception
Message 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 π Emoji), also include Items 2.B, 3 & 4 in Commit Message too.
- Award that Task with
Manufacturing Defect
Token(Phabricator Specific).
- Do NOT edit Contents of
Vendor
files(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.