├── Gemfile
├── .gitignore
├── _config.yml
├── _includes
    └── head-custom-google-analytics.html
└── README.md


/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 | gem 'github-pages', group: :jekyll_plugins
3 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | 
2 | ### Ruby ###
3 | Gemfile.lock
4 | 
5 | ### Jekyll ###
6 | _site/
7 | .sass-cache/
8 | .jekyll-metadata
9 | 


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-hacker
2 | show_downloads: false
3 | google_analytics: G-C7NWEL14V3
4 | gems:
5 |   - jemoji
6 | 


--------------------------------------------------------------------------------
/_includes/head-custom-google-analytics.html:
--------------------------------------------------------------------------------
 1 | {% if site.google_analytics %}
 2 |   <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
 3 |   <script>
 4 |     window.dataLayer = window.dataLayer || [];
 5 |     function gtag(){dataLayer.push(arguments);}
 6 |     gtag('js', new Date());
 7 | 
 8 |     gtag('config', '{{ site.google_analytics }}');
 9 |   </script>
10 | {% endif %}
11 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Available Grammar
 2 | =================
 3 |   - `@TODO`: Something to be done
 4 |   - [`@FIXME`](#bug-report): Bug Report, should be corrected, Marked with :bug: Commit
 5 |   - `@CHANGED`: Version Changes together with `@SINCE` DocComment, _Usually_ Marked with :fire: or :zap: Commits
 6 |   - `@XXX`: Warn other programmers of problematic or misguiding code
 7 |   - `@IDEA`: A New Idea or Proof-of-Concept, Marked with :bulb: Commit
 8 |   - `@HACK`: Workaround or Customer Customizations, Marked with :ribbon: Commit
 9 |   - `@NOTE`: Add attention to something Important
10 |   - `@REVIEW`: Needs to be Audited/Reviewed Immediately, _Usually_ Marked with :construction: Commit
11 | 
12 | Bug Report
13 | ----------
14 | 1. Add `@FIXME` Comment above SourceCode where Bug/Exception was Occurred.
15 | 2. Write Additional Information:
16 |     1. Steps to Reproduce the Error
17 |     2. `Exception` Message and Code
18 |     3. Expected Result
19 |     4. Actual Result
20 |     5. Environment Detail
21 | 3. Mention the Task ID in Format `{T###}`.
22 | 4. (optional) Add Screenshots in Format `{F###}`(_Phabricator Specific_).
23 | 5. Commit the Comments(with :bug: Emoji), also include Items 2.B, 3 & 4 in Commit Message too.
24 | 6. Award that Task with `Manufacturing Defect` Token(_Phabricator Specific_).
25 | 
26 | Notes
27 | -----
28 | + Do **NOT** edit Contents of `Vendor` files(Composer, Bower, ...).
29 | + 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)).
30 | + There Must be an Audit for this Bug(Commit) Appear in Phabricator.
31 | + These Kind of Bug Reports Remain in History of VCS for future References of that Scope of Code.
32 | + All Attached Files & Commit Reference HashTag will be Referenced in the Phabricator Task View.
33 | + These Audits May become Tasks Later.
34 | 
35 | ##### References
36 |   - https://en.wikipedia.org/wiki/Comment_(computer_programming)#Tags
37 |   - https://softwareengineering.stackexchange.com/questions/65467/what-does-xxx-mean-in-a-comment
38 | 


--------------------------------------------------------------------------------