docs: document output formats and move dev docs#17
Merged
Conversation
added 2 commits
August 25, 2025 14:15
- README: document --format option (text/json/codeclimate) and add examples.\n- README: remove Development Setup and link to new docs.\n- New BUILD.md: local build/install and basic commands.\n- New CONTRIBUTING.md: development setup and test instructions.\n\nNo code changes.
Add a small .pre-commit-config.yaml snippet showing --format codeclimate with --output-file for CI code quality reports.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the docs to cover the new output format options and moves development content out of README.
Changes:
No code changes.