Archived issue #0028814
Documentation - suggest using # instead of // for temporary comments in commit description
Description
Existing bug advancement workflow suggest the following syntax:
The // syntax is familiar to C++ developers, but incompatible with native git tools. When using git, the automatically added comments (e.g. within merge conflict or re-base operation) are started with #, and such comments are automatically withdrawn while confirming commit description within rebase operation.
Therefore, it is proposed using # instead of // for consistency with native git tools (or allow both).
Minor corrections ... Minor commits should have a single-line message starting with //. These messages will be ignored when the branch is squashed at integration.
The // syntax is familiar to C++ developers, but incompatible with native git tools. When using git, the automatically added comments (e.g. within merge conflict or re-base operation) are started with #, and such comments are automatically withdrawn while confirming commit description within rebase operation.
Therefore, it is proposed using # instead of // for consistency with native git tools (or allow both).
Steps to reproduce
N/A
Public activity
4 archived notes
Participants are labeled by their role within this record.
Branch [archived branch] has been created by Author.
[revision removed]
Detailed log of new commits:
Author: Author
Date: Mon Jun 5 16:15:04 2017 +0300
0028814: Documentation - suggest using # instead of // for temporary comments in commit description
[revision removed]
Detailed log of new commits:
Author: Author
Date: Mon Jun 5 16:15:04 2017 +0300
0028814: Documentation - suggest using # instead of // for temporary comments in commit description
Patch is ready for review.
No remarks, please integrate. Please also announce this change internally
Branch [archived branch] has been deleted by Author.
[revision removed]
[revision removed]