Add documentation, examples, and CI/CD setup#3
Merged
Conversation
- Add comprehensive README with installation, API overview, and usage guide - Add 4 examples: basic, batch_alerts, resolve_alert, custom_middleware - Add reqwest-retry dev-dependency for custom middleware example - Add pre-commit configuration with rustfmt, clippy, and standard hooks
- Add CI workflow with fmt, clippy, test, coverage, and security audit - Add release workflow for tag-based GitHub releases - Add issue and PR templates - Add CODEOWNERS and devcontainer configuration - Add AGENTS.md with build/test/lint instructions - Update Cargo.toml with repository metadata - Update README with badges and git-based installation
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.
Summary
Changes
Documentation
examples/directoryCI/CD
.github/workflows/ci.yml- format, lint, test, coverage, security.github/workflows/release.yml- automated releases on tag push.github/CODEOWNERS, issue templates, PR templateConfiguration
.devcontainer/devcontainer.jsonfor VS Code dev containers.pre-commit-config.yamlfor local quality gatesAGENTS.mdwith build/test/lint instructionsTest plan
cargo test)cargo check --examples)