Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 59f6ea7

Browse files
author
Mohammad Shokri
committed
✨ Introduce Comment Tags Grammar
1 parent 5bc8837 commit 59f6ea7

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

‎README.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Notes
3131
+ There is a **Space** Character between Multiple Emojis!.
3232
+ There is **NO** New-Line After the _Task ID Reference_ Line.
3333
+ Every Raw Emoji Text(`:emoji:`) is Counted as One Char!.
34+
+ See [ToDo Grammar StyleGuide](https://github.com/slashsBin/styleguide-todo-grammar) for more Information on `@XXX` Comment Tags.
3435

3536
---
3637

@@ -42,30 +43,30 @@ Suggested Emojis
4243
| :art: | `:art:` | when improving the **format**/structure of the code |
4344
| :racehorse: | `:racehorse:` | when improving **performance** |
4445
| :books: | `:books:` | when writing **docs** |
45-
| :bug: | `:bug:` | when reporting a **bug** |
46+
| :bug: | `:bug:` | when reporting a **bug**, with [`@FIXME`](https://github.com/slashsBin/styleguide-todo-grammar#bug-report)Comment Tag |
4647
| :ambulance: | `:ambulance:` | when fixing a **bug** |
4748
| :penguin: | `:penguin:` | when fixing something on **Linux** |
4849
| :apple: | `:apple:` | when fixing something on **Mac OS** |
4950
| :checkered_flag: | `:checkered_flag:` | when fixing something on **Windows** |
50-
| :fire: | `:fire:` | when **removing code** or files |
51+
| :fire: | `:fire:` | when **removing code** or files, _maybe_ with `@CHANGED` Comment Tag |
5152
| :white_check_mark: | `:white_check_mark:` | when adding **tests** |
5253
| :green_heart: | `:green_heart:` | when fixing the **CI** build |
5354
| :lock: | `:lock:` | when dealing with **security** |
5455
| :arrow_up: | `:arrow_up:` | when upgrading **dependencies** |
5556
| :arrow_down: | `:arrow_down:` | when downgrading **dependencies** |
5657
| :shirt: | `:shirt:` | when removing **linter**/strict/deprecation warnings |
5758
| :lipstick: | `:lipstick:` | when improving **UI**/Cosmetic |
58-
| :construction: | `:construction:` | **WIP**(Work In Progress) Commits |
59+
| :construction: | `:construction:` | **WIP**(Work In Progress) Commits, _maybe_ with `@REVIEW` Comment Tag |
5960
| :gem: | `:gem:` | New **Release** |
6061
| :bookmark: | `:bookmark:` | Version **Tags** |
6162
| :tada: | `:tada:` | **Initial** Commit |
6263
| :speaker: | `:speaker:` | when Adding **Logging** |
6364
| :mute: | `:mute:` | when Reducing **Logging** |
6465
| :sparkles: | `:sparkles:` | when introducing **New** Features |
65-
| :zap: | `:zap:` | when introducing **Backward-InCompatible** Features |
66-
| :bulb: | `:bulb:` | New **Idea** |
66+
| :zap: | `:zap:` | when introducing **Backward-InCompatible** Features, _maybe_ with `@CHANGED` Comment Tag |
67+
| :bulb: | `:bulb:` | New **Idea**, with `@IDEA` Comment Tag |
6768
| :snowflake: | `:snowflake:` | changing **Configuration**, Usually together with :penguin: or :ribbon: or :rocket: |
68-
| :ribbon: | `:ribbon:` | Customer requested application **Customization** |
69+
| :ribbon: | `:ribbon:` | Customer requested application **Customization**, with `@HACK` Comment Tag |
6970
| :rocket: | `:rocket:` | Anything related to Deployments/**DevOps** |
7071

7172
Ask to Be [Creative](http://www.emoji-cheat-sheet.com/)!

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /