Readme fix #56
Readme fix #56
Conversation
WalkthroughThe updates primarily focus on enhancing the installation process, improving documentation, and refining build and environment management scripts. Key highlights include: upgrading Changes
Poem
Tip AI model upgrade
|
github-actions
bot
added
github-actions
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/build.yml (1 hunks)
- README.md (2 hunks)
Files skipped from review due to trivial changes (1)
- .github/workflows/build.yml
Additional context used
Markdownlint
README.md
1-1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
33-33: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
38-38: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
32-32: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
42-42: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
34-34: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
37-37: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
39-39: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
41-41: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
33-33: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
33-33: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
38-38: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
38-38: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
Additional comments not posted (3)
README.md (3)
4-4: LGTM!The code coverage badge from SonarCloud has been correctly added.
5-5: LGTM!The quality gate badge from SonarCloud has been correctly added.
11-11: LGTM!The GitHub commit activity badge has been correctly commented out.
| * using HomeBrew | ||
| ```console | ||
| brew tap hckr-cli/tap | ||
| brew install hckr | ||
| ``` |
There was a problem hiding this comment.
Fix markdownlint issues.
The HomeBrew installation instructions are clear and correct. However, there are markdownlint issues to address:
- Headings should be surrounded by blank lines (MD022).
- Unordered list style should be consistent (MD004).
- Fenced code blocks should be surrounded by blank lines (MD031).
- Lists should be surrounded by blank lines (MD032).
## Installation
- using HomeBrew
+
```console
brew tap hckr-cli/tap
brew install hckr- using pip
pip install hckr
<details>
<summary>Tools</summary>
<details>
<summary>Markdownlint</summary><blockquote>
33-33: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
---
34-34: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
---
37-37: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
---
33-33: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
---
33-33: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
</blockquote></details>
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (2 hunks)
Additional context used
Markdownlint
README.md
9-9: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
1-1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
34-34: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
39-39: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
33-33: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
43-43: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
35-35: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
38-38: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
40-40: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
42-42: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
34-34: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
34-34: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
39-39: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
39-39: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
Additional comments not posted (4)
README.md (4)
4-5: LGTM!The new badges for coverage and quality gate are correctly added and provide useful information.
12-12: LGTM!The GitHub commit activity badge has been correctly commented out.
34-38: Fix markdownlint issues.The HomeBrew installation instructions are clear and correct. However, there are markdownlint issues to address:
- Headings should be surrounded by blank lines (MD022).
- Unordered list style should be consistent (MD004).
- Fenced code blocks should be surrounded by blank lines (MD031).
- Lists should be surrounded by blank lines (MD032).
## Installation - using HomeBrew + ```console brew tap hckr-cli/tap brew install hckr<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 34-34: Expected: dash; Actual: asterisk Unordered list style (MD004, ul-style) --- 35-35: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 38-38: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 34-34: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) --- 34-34: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) </blockquote></details> </details> --- `39-40`: **Fix markdownlint issues.** The pip installation instructions are correct. However, there are markdownlint issues to address: - Fenced code blocks should be surrounded by blank lines (MD031). - Lists should be surrounded by blank lines (MD032). ```diff - using pip + ```console pip install hckr<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 39-39: Expected: dash; Actual: asterisk Unordered list style (MD004, ul-style) --- 40-40: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 39-39: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) --- 39-39: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) </blockquote></details> </details> </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
github-actions
bot
added
documentation
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
pyproject.tomlis excluded by!**/*.toml
Files selected for processing (2)
- Makefile (3 hunks)
- docs/source/_templates/components/nav-versions.html (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/source/_templates/components/nav-versions.html
Additional comments not posted (2)
Makefile (2)
4-5: LGTM! But verify all references to the renamed target.The
env-cleantarget has been renamed toenv-prune.However, ensure that all references to
env-cleanhave been updated toenv-prune.Verification successful
All references to
env-cleanhave been updated toenv-prune.The
env-cleantarget has been successfully renamed toenv-prunewithout any remaining references to the old target.
- No occurrences of
env-cleanfound in the Makefile.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `env-clean` have been updated to `env-prune`. # Test: Search for any references to `env-clean`. Expect: No results. rg --type makefile $'env-clean'Length of output: 63
Script:
#!/bin/bash # Description: Verify all references to `env-clean` have been updated to `env-prune`. # Test: Search for any references to `env-clean` in Makefiles. Expect: No results. rg 'env-clean' --glob 'Makefile'Length of output: 30
15-15: LGTM! But verify all references to the removed target.The
env-defaulttarget has been removed.However, ensure that all references to
env-defaulthave been removed.Verification successful
All references to
env-defaulthave been successfully removed.The verification script found no remaining references to
env-defaultin any Makefile.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `env-default` have been removed. # Test: Search for any references to `env-default`. Expect: No results. rg --type makefile $'env-default'Length of output: 65
Script:
#!/bin/bash # Description: Verify all references to `env-default` have been removed. # Locate all Makefiles and search for references to `env-default`. fd -e mk -e makefile | xargs rg 'env-default'Length of output: 45
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
pyproject.tomlis excluded by!**/*.toml
Files selected for processing (2)
- .gitignore (1 hunks)
- Makefile (2 hunks)
Files skipped from review due to trivial changes (1)
- .gitignore
Files skipped from review as they are similar to previous changes (1)
- Makefile
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/source/_templates/partials/foot-socials.html (1 hunks)
- docs/source/conf.py (1 hunks)
Files skipped from review due to trivial changes (2)
- docs/source/_templates/partials/foot-socials.html
- docs/source/conf.py
|
No description provided.