You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Instantly review and improve your Python code to keep your codebase maintainable.
6
5
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.
8
7
9
8
## CLI
10
9
11
10
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.
12
11
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.
14
13
15
14
## CI & Pre-Commit
16
15
17
16
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/).
18
17
19
-
For CI we recommend using
18
+
For CI we recommend using:
20
19
21
20
```yaml
22
21
pip install sourcery
@@ -45,7 +44,7 @@ Note: Sourcery is fully free for open-source projects - but you need a [Team pla
45
44
46
45
## IDE Integration
47
46
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.
49
48
50
49
Find quick installation instructions here:
51
50
@@ -58,7 +57,7 @@ More editor integrations coming soon.
58
57
59
58
## GitHub Code Reviews
60
59
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.
62
61
63
62
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.
64
63
@@ -80,4 +79,6 @@ Let the world know your project is using Sourcery to refactor with this badge:
0 commit comments