docs: add agent guidance#94
Closed
MRNIU wants to merge 4 commits intodrivercraft:mainfrom
Closed
Conversation
Initialize repository and project-local guidance for agents. - Document dependency, git, validation, documentation, and Rust conventions at the repository root. - Add scoped instructions for each workspace crate and the server web UI.
Remove local Docker-first policy from the project guidance. - Keep repository and CI-declared tool versions as validation evidence. - Ask agents to report missing tools instead of encoding host setup rules.
Use Chinese as the primary language for AGENTS guidance to match the repository's default README. - Keep commands, paths, crate names, and package manager names unchanged. - Preserve environment hygiene guidance by reporting missing tools instead of changing host setup.
Keep AGENTS guidance focused on repository-declared tools and checks. - Remove explicit Docker and Dev Container references from root guidance. - Avoid suggesting global installs as an environment workaround.
Author
|
这个 draft PR 已由 #95 取代：新 PR 使用 README 示例中的 feature 分支风格，并将 4 个提交合并为 1 个中文提交。 |
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
AGENTS.mdwith scoped guidance for future AI-assisted changes.AGENTS.mdfiles for each workspace crate and theostool-server/webuifrontend.Community question
This PR proposes documenting an AI-assisted development workflow through
AGENTS.mdfiles. Is this style of AI-driven contribution guidance acceptable for this project/community?If the community prefers a different location, wording, language, or scope for these instructions, this draft is intended as a place to discuss that before marking it ready.
Review notes
ostool-serverguidance calls out thatcargo test -p ostool-servermay invoke pnpm throughbuild.rs, so missing tools should be reported rather than hidden by committing generated artifacts or changing tool sources.Tests
git diff --check upstream/main...HEADDocker,Dev Container,brew,npm -g,rustup,pyenv, etc.).