Edit - Software Engineering Stack Exchange

You are not logged in. Your edit will be placed in a queue until it is peer reviewed.

We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.

Required fields*

Rev

This is a false dichotomy. Why can't you have design comments ("this is why we did x y z") when necessary and mention bug ids in commit messages?

Matthew Flaschen
– Matthew Flaschen

2011-07-26 15:24:14 +00:00
Commented Jul 26, 2011 at 15:24
Where does it say that you can't? I was referring to bug IDs in code, not VCS commit messages.

fejd
– fejd

2011-07-26 15:34:39 +00:00
Commented Jul 26, 2011 at 15:34
Sorry, I misunderstood. I thought you were saying it wasn't useful to put bug ids anywhere.

Matthew Flaschen
– Matthew Flaschen

2011-07-26 15:38:38 +00:00
Commented Jul 26, 2011 at 15:38
No problem, that just means my answer was not clear enough. :)

fejd
– fejd

2011-07-26 15:48:30 +00:00
Commented Jul 26, 2011 at 15:48

Add a comment |

Correct minor typos or mistakes
Clarify meaning without changing it
Add related resources or links
Always respect the author’s intent
Don’t use edits to reply to the author

create code fences with backticks ` or tildes ~
```
like so
```
add language identifier to highlight code
```python
def function(foo):
print(foo)
```
put returns between paragraphs
for linebreak add 2 spaces at end
_italic_ or **bold**
indent code by 4 spaces
backtick escapes `like _so_`
quote by placing > at start of line
to make links (use https whenever possible)

<https://example.com>

[example](https://example.com)

<a href="https://example.com">example</a>

formatting help »
answering help »