Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add linter section to CLI README.md #244

Merged
merged 2 commits into from
Jan 24, 2025
Merged

Add linter section to CLI README.md #244

merged 2 commits into from
Jan 24, 2025

Conversation

BD103
Copy link
Member

@BD103 BD103 commented Jan 24, 2025

Closes #239!

The section is pretty sparse, especially because I intentionally omitted the installation instructions (they're too complicated + too likely to go out-of-date, in my opinion).

As an extra drive-by fix, I switched the cli code block attributes to sh, which fixes syntax highlighting for me in VSCode. I can revert this if it's not desired!

BD103 added 2 commits January 23, 2025 23:09
`cli` isn't recognized unfortunately. While shell `sh` isn't cross platform, it's recognized by most code highlighters.
@BD103 BD103 added A-CLI Related to the main CLI and not a more specific subcommand C-Docs An improvement in documentation S-Needs-Review The PR needs to be reviewed before it can be merged labels Jan 24, 2025
Copy link
Collaborator

@TimJentzsch TimJentzsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I think it's sufficient for now :)

@TimJentzsch TimJentzsch merged commit 3a4db2d into main Jan 24, 2025
8 checks passed
@TimJentzsch TimJentzsch deleted the cli-linter-readme branch January 24, 2025 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-CLI Related to the main CLI and not a more specific subcommand C-Docs An improvement in documentation S-Needs-Review The PR needs to be reviewed before it can be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a section about the linter in the README
2 participants