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.

One approach, if using Git, is to compose a pull request of multiple commits. Each commit is as atomic and self-contained as possible, and has its own description. Then, add a helpful note in the PR body that each change can be reviewed manually. That's generally how I handle very large PRs, like global refactors or big, unassailable tooling changes.

Jimmy Breck-McKye
– Jimmy Breck-McKye

2016-12-19 10:35:33 +00:00
Commented Dec 19, 2016 at 10:35

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 »