https://github.com/slashsbin/styleguide-todo-grammar

/sBin/StyleGuide/ToDo
https://github.com/slashsbin/styleguide-todo-grammar

comment style-guide styleguide todo

Last synced: 3 months ago
JSON representation

/sBin/StyleGuide/ToDo

• Host: GitHub
• URL: https://github.com/slashsbin/styleguide-todo-grammar
• Owner: slashsbin
• Created: 2016-02-19T11:35:58.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-14T05:49:28.000Z (10 months ago)
• Last Synced: 2024-04-14T21:56:59.929Z (10 months ago)
• Topics: comment, style-guide, styleguide, todo
• Language: Ruby
• Homepage: http://slashsbin.dev/styleguide-todo-grammar/
• Size: 5.86 KB
• Stars: 20
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Available Grammar

=================

  - `@TODO`: Something to be done

  - [`@FIXME`](#bug-report): Bug Report, should be corrected, Marked with :bug: Commit

  - `@CHANGED`: Version Changes together with `@SINCE` DocComment, _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

----------

1. Add `@FIXME` Comment above SourceCode where Bug/Exception was Occurred.

2. Write Additional Information:

    1. Steps to Reproduce the Error

    2. `Exception` Message and Code

    3. Expected Result

    4. Actual Result

    5. Environment Detail

3. Mention the Task ID in Format `{T###}`.

4. (optional) Add Screenshots in Format `{F###}`(_Phabricator Specific_).

5. Commit the Comments(with :bug: Emoji), also include Items 2.B, 3 & 4 in Commit Message too.

6. Award that Task with `Manufacturing Defect` Token(_Phabricator Specific_).

Notes

-----

+ Do **NOT** edit Contents of `Vendor` files(Composer, Bower, ...).

+ Grammars Should Appear in a List/Window in Your IDE of Choice([PHPStorm](https://www.jetbrains.com/help/phpstorm/2016.2/defining-todo-patterns-and-filters.html)).

+ 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