feat(dev): introduce AGENTS.md #23858
Draft
Conversation
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| # Code quality checks | ||
| make check # Format, clippy, docs | ||
| make check-fmt # Format checking only | ||
| make check-clippy # Linting only |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error
|
|
||
| ### Quality Gates | ||
| - **Code Formatting**: rustfmt enforcement | ||
| - **Linting**: Clippy with custom rules |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error
| - `api/` - GraphQL API for management and monitoring | ||
| - `cli.rs` - Command-line interface | ||
|
|
||
| - `/lib/` - Modular library crates |
Comment on lines
+42
to
+51
| #### Environment Setup | ||
| ```bash | ||
| # Use containerized development environment (recommended for new contributors) | ||
| export CONTAINER_TOOL="podman" # Optional: default is docker | ||
| make environment # Enter development shell | ||
|
|
||
| # Or setup native environment | ||
| cargo install -f --path vdev # Install Vector development CLI | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Suggested change
| #### Environment Setup | |
| ```bash | |
| # Use containerized development environment (recommended for new contributors) | |
| export CONTAINER_TOOL="podman" # Optional: default is docker | |
| make environment # Enter development shell | |
| # Or setup native environment | |
| cargo install -f --path vdev # Install Vector development CLI | |
| ``` |
We don't want to actually develop inside the environment or to install vdev when we can use cargo vdev instead
Comment on lines
+54
to
+57
| # Development build | ||
| make build-dev | ||
| # or in container | ||
| make build-dev ENVIRONMENT=true |
There was a problem hiding this comment.
We should probably replace this with cargo commands and also instruct to use --no-default-features --features="foo,bar,baz" to improve compile times
| make test-integration | ||
|
|
||
| # Specific integration test | ||
| make test-integration-SCOPE="kafka" |
There was a problem hiding this comment.
Suggested change
| make test-integration-SCOPE="kafka" | |
| make test-integration-kafka |
I think -SCOPE is wrong
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
LLM generated - Needs review.
Vector configuration
How did you test this PR?
Change Type
Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.References
Notes
@vectordotdev/vectorto reach out to us regarding this PR.pre-pushhook, please see this template.make fmtmake check-clippy(if there are failures it's possible some of them can be fixed withmake clippy-fix)make testgit merge origin masterandgit push.Cargo.lock), pleaserun
make build-licensesto regenerate the license inventory and commit the changes (if any). More details here.