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.

The Linux kernel repository has lots of good examples of violating this rule -- they often have lots of explanation about the cause of the bug or the rationale for the fix in the body of the commit message. A reasonable version of your rule would be "you should always be able to explain the main point of a commit in 1 sentence."

Ken Bloom
– Ken Bloom

2010-10-11 03:33:05 +00:00
Commented Oct 11, 2010 at 3:33
@Ken: my goal here is to help the person asking the question, not to come up with a rule covering all pre-existing source code repositories in the world.

azheglov
– azheglov

2010-10-11 12:55:24 +00:00
Commented Oct 11, 2010 at 12:55

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 »