Skip to content

Commit

Permalink
Use a before and after framing in the readme (#62)
Browse files Browse the repository at this point in the history
Co-authored-by: Aidan Do <aidan.do@nqry.com.au>
  • Loading branch information
aidando73 and Aidan Do authored Nov 3, 2022
1 parent 8f68772 commit bb6b349
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@ Several users have requested this [feature](https://jira.atlassian.com/browse/BC
It is unlikely that Bitbucket will implement this feature, and thus this extension was created.

Syntax highlighting is not just for cosmetics, it's significantly easier to read code when it's highlighted.
Suppose you were tasked with reviewing this file:

🙁 Before:

![Before](./design/vagrantfile-non-highlighted.png)

The same file is much easier to read when it's highlighted:
😄 After:

![After](./design/vagrantfile-highlighted.png)

The latter is easier to review, as there is separation between comments, variables, constants, functions, classes, keywords, etc.
This extension will:
Therefore, this extension will:

- ✅ Decrease the cognitive load of reviewing code
- ✅ Decrease the time it takes to review a pull request
Expand Down

0 comments on commit bb6b349

Please sign in to comment.