Stone_Red/naming-convention
1
0
Fork 0
mirror of https://github.com/Stone-Red-Code/naming-convention.git synced 2026-09-04 00:56:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #34 from jokyjoe-joy/patch-1

Browse Source 
Fixed typos
This commit is contained in:
Konstantin Taranov
2021-03-19 11:13:42 +03:00
committed by GitHub
parent 27c4d1eb97 0ceb0dfb7e
commit ef12438694
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Git Comment Convention.md
+5 -5
View File
@@ -4,15 +4,15 @@
## Comment structure
1. First line is a subject line. It should have size about 50 characters, maximum limit is 80. Subject line is capitalized and hasn't period at the end;
2. A blank line separates subject from body;
3. Detailed description of the change in the body, breaking paragraphs where needed.The body should explain what you did and why vs. how. The body also starts with a capitalized letter. Bullet points are made with an asterisk (*);
4. In case if a bug tracking system is used, bug Id is line is placed at the very end after a blank line.
3. Detailed description of the change in the body, breaking paragraphs where needed. The body should explain what you did and why vs. how. The body also starts with a capitalized letter. Bullet points are made with an asterisk (*);
4. In case if a bug tracking system is used, bug Id's line is placed at the very end after a blank line.
## Subject line tags
- [FEATURE]: A new feature (also small additions). Most likely it will be an added feature, but it could also be removed;
- [BUGFIX]: A fix for a bug;
- [STYLE]: Changes in layout, page style and css files;
- [CLEANUP]: Code formatting, improves in code style and readability;
- [CLEANUP]: Code formatting, improvements in code style and readability;
- [DOCS]: Changes to documentation;
- [TEST]: Adding, changing, refactoring tests - no production code change;
- [OTHER]: Anything not covered by the above categories.
@@ -26,7 +26,7 @@
## Tags usage examples
1. [STYLE] Change size of tag h1
2. [CLEANUP] Few code formating
2. [CLEANUP] Few code formatting
3. [BUGFIX] Fix bugs 101 and 110
4. [FEATURE] Add new universal system class object
5. (!!!)[FEATURE] Added new class ChartItem
@@ -46,7 +46,7 @@ Additional information about commit changes
- [How to Write a Git Commit Message ](https://webcache.googleusercontent.com/search?q=cache:PM7POmjONvgJ:https://chris.beams.io/posts/git-commit/+&cd=1&hl=sl&ct=clnk&gl=si&client=firefox-b-d)
## Usefull links
## Useful links
- [Better Code Reviews with GIT](https://www.red-gate.com/simple-talk/dotnet/software-delivery/better-code-reviews-with-git/)
- [Part 1: Pre-Review Comments](https://www.red-gate.com/simple-talk/dotnet/.net-framework/the-zen-of-code-reviews-pre-review-comments/)
- [Part 2: Best Practices](https://www.red-gate.com/simple-talk/dotnet/.net-framework/the-zen-of-code-reviews-best-practices/)