{"id":20267408,"url":"https://github.com/slashsbin/styleguide-todo-grammar","last_synced_at":"2025-04-11T03:37:06.720Z","repository":{"id":69685742,"uuid":"52083783","full_name":"slashsbin/styleguide-todo-grammar","owner":"slashsbin","description":"/sBin/StyleGuide/ToDo","archived":false,"fork":false,"pushed_at":"2024-04-18T06:26:26.000Z","size":8,"stargazers_count":20,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T01:38:31.125Z","etag":null,"topics":["comment","style-guide","styleguide","todo"],"latest_commit_sha":null,"homepage":"http://slashsbin.dev/styleguide-todo-grammar/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slashsbin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2016-02-19T11:35:58.000Z","updated_at":"2024-04-18T06:26:29.000Z","dependencies_parsed_at":"2023-06-03T18:45:22.767Z","dependency_job_id":null,"html_url":"https://github.com/slashsbin/styleguide-todo-grammar","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slashsbin%2Fstyleguide-todo-grammar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slashsbin%2Fstyleguide-todo-grammar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slashsbin%2Fstyleguide-todo-grammar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slashsbin%2Fstyleguide-todo-grammar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slashsbin","download_url":"https://codeload.github.com/slashsbin/styleguide-todo-grammar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248338029,"owners_count":21087151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comment","style-guide","styleguide","todo"],"created_at":"2024-11-14T12:14:35.404Z","updated_at":"2025-04-11T03:37:06.698Z","avatar_url":"https://github.com/slashsbin.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"Available Grammar\n=================\n  - `@TODO`: Something to be done\n  - [`@FIXME`](#bug-report): Bug Report, should be corrected, Marked with :bug: Commit\n  - `@CHANGED`: Version Changes together with `@SINCE` DocComment, _Usually_ Marked with :fire: or :zap: Commits\n  - `@XXX`: Warn other programmers of problematic or misguiding code\n  - `@IDEA`: A New Idea or Proof-of-Concept, Marked with :bulb: Commit\n  - `@HACK`: Workaround or Customer Customizations, Marked with :ribbon: Commit\n  - `@NOTE`: Add attention to something Important\n  - `@REVIEW`: Needs to be Audited/Reviewed Immediately, _Usually_ Marked with :construction: Commit\n\nBug Report\n----------\n1. Add `@FIXME` Comment above SourceCode where Bug/Exception was Occurred.\n2. Write Additional Information:\n    1. Steps to Reproduce the Error\n    2. `Exception` Message and Code\n    3. Expected Result\n    4. Actual Result\n    5. Environment Detail\n3. Mention the Task ID in Format `{T###}`.\n4. (optional) Add Screenshots in Format `{F###}`(_Phabricator Specific_).\n5. Commit the Comments(with :bug: Emoji), also include Items 2.B, 3 \u0026 4 in Commit Message too.\n6. Award that Task with `Manufacturing Defect` Token(_Phabricator Specific_).\n\nNotes\n-----\n+ Do **NOT** edit Contents of `Vendor` files(Composer, Bower, ...).\n+ 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)).\n+ There Must be an Audit for this Bug(Commit) Appear in Phabricator.\n+ These Kind of Bug Reports Remain in History of VCS for future References of that Scope of Code.\n+ All Attached Files \u0026 Commit Reference HashTag will be Referenced in the Phabricator Task View.\n+ These Audits May become Tasks Later.\n\n##### References\n  - https://en.wikipedia.org/wiki/Comment_(computer_programming)#Tags\n  - https://softwareengineering.stackexchange.com/questions/65467/what-does-xxx-mean-in-a-comment\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslashsbin%2Fstyleguide-todo-grammar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslashsbin%2Fstyleguide-todo-grammar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslashsbin%2Fstyleguide-todo-grammar/lists"}