Skip to content

Commit c18fe81

Browse files
docs: add short description for adding a Sourcery badge to READMEs (#333)
Add paragraph explaining how to add a Sourcery badge to READMEs. Also fix minor issues with colons and periods. --------- Co-authored-by: Ruan Comelli <[email protected]>
1 parent 0ff6e61 commit c18fe81

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
[![Sourcery](https://img.shields.io/badge/Sourcery-enabled-brightgreen)](https://sourcery.ai)
22

3-
43
## Sourcery
54
Instantly review and improve your Python code to keep your codebase maintainable.
65

7-
Get started with our CLI to have Sourcery review all your code locally or star this repo to have our GitHub bot review your most popular Python repo
6+
Get started with our CLI to have Sourcery review all your code locally or star this repo to have our GitHub bot review your most popular Python repo.
87

98
## CLI
109

1110
You can have Sourcery review your entire project and make dozens or hundreds (or thousands) of improvements with a single command from the command line.
1211

13-
To start `pip install sourcery`, login with `sourcery login`, and then run `sourcery review <some path>` to have Sourcery review and make suggestions on every file in that path
12+
To start `pip install sourcery`, login with `sourcery login`, and then run `sourcery review <some path>` to have Sourcery review and make suggestions on every file in that path.
1413

1514
## CI & Pre-Commit
1615

1716
Keep your entire codebase standardized with Sourcery’s [CI integration](https://docs.sourcery.ai/Guides/Getting-Started/CI/) and [pre-commit hook](https://docs.sourcery.ai/Guides/Getting-Started/Pre-Commit/).
1817

19-
For CI we recommend using
18+
For CI we recommend using:
2019

2120
```yaml
2221
pip install sourcery
@@ -45,7 +44,7 @@ Note: Sourcery is fully free for open-source projects - but you need a [Team pla
4544
4645
## IDE Integration
4746
48-
Sourcery integrates into your editor to review and improve your code while you’re writing it
47+
Sourcery integrates into your editor to review and improve your code while you’re writing it.
4948
5049
Find quick installation instructions here:
5150
@@ -58,7 +57,7 @@ More editor integrations coming soon.
5857
5958
## GitHub Code Reviews
6059
61-
Ensure your code is always at the highest quality. Sourcery reviews and makes suggestions on your whole repo when you install and then checks all new pull requests in the future
60+
Ensure your code is always at the highest quality. Sourcery reviews and makes suggestions on your whole repo when you install and then checks all new pull requests in the future.
6261
6362
You can get set up and running in 1 minute. Just follow this [link](https://github.com/apps/sourcery-ai/installations/new) and select your repos.
6463
@@ -80,4 +79,6 @@ Let the world know your project is using Sourcery to refactor with this badge:
8079
8180
[![Sourcery](https://img.shields.io/badge/Sourcery-enabled-brightgreen)](https://sourcery.ai)
8281
82+
Copy the code below into your README to display your Sourcery badge:
83+
8384
[![Sourcery](https://img.shields.io/badge/Sourcery-enabled-brightgreen)](https://sourcery.ai)

0 commit comments

Comments
 (0)