Skip to content

Commit

Permalink
[style guide] Include output of shell commands
Browse files Browse the repository at this point in the history
  • Loading branch information
nichtmax authored Sep 13, 2022
1 parent 58d8736 commit 1ed580c
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ isabell.uber.space

- Document all steps for setup. E.g. [create a database](https://github.com/Uberspace/lab/issues/39) when that's necessary. [Create directories](https://github.com/Uberspace/lab/issues/36) when needed.
- When there is a license needed for the software mention it.
- Include output of shell commands if there is any.
- If there are interactive shell sessions, emphasize the lines that expect input from the user. For example:

```
Expand Down

0 comments on commit 1ed580c

Please sign in to comment.