docs: add instructions for coding agents - #3608
Open
user01010111 wants to merge 3 commits into
Open
Conversation
Add a root AGENTS.md which directs coding agents to existing NUT contribution requirements and recurring project-specific review checks. Tell contributors using coding agents to ensure their tool reads the file, and register it for source distribution. AI assistance: OpenAI Codex gpt-5.6-sol was used for research, drafting and review. The human contributor remains responsible for the change. Signed-off-by: user01010111 <lapses.50.booster@icloud.com>
|
A ZIP file with standard source tarball and another tarball with pre-built docs for commit 9d65221 is temporarily available: NUT-tarballs-PR-3608.zip. |
Wrap agent guidance source lines consistently with existing NUT documentation while preserving the rendered text. AI assistance: OpenAI Codex gpt-5.6-sol was used for drafting and validation. The human contributor remains responsible for the change. Signed-off-by: user01010111 <lapses.50.booster@icloud.com>
|
✅ Build nut 2.8.5.5179-master completed (commit 491f7664e3 by @)
|
|
✅ Build nut 2.8.5.5179-master completed (commit 491f7664e3 by @) |
|
✅ Build nut 2.8.5.5180-master completed (commit 6627b98fc2 by @)
|
jimklimov
added
documentation
CI
jimklimov
added a commit
to user01010111/nut
that referenced
this pull request
Sep 1, 2026
networkupstools#3608] Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
networkupstools#3608] Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
jimklimov
force-pushed
the
docs/agent-guidance
branch
from
September 1, 2026 08:11
1a46f9d to
9d65221
Compare
|
❌ Build nut 2.8.5.5187-master failed (commit 34a58c86c3 by @jimklimov) |
|
✅ Build nut 2.8.5.5196-master completed (commit 34a58c86c3 by @jimklimov)
|
|
✅ Build nut 2.8.5.5196-master completed (commit 34a58c86c3 by @jimklimov) |
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
3 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.
Aims to close #3606, pending maintainer review and approval.
This adds a concise root
AGENTS.md, registers it for source distribution, and tells contributors using coding agents to ensure their tool reads it.This is not intended to encourage or increase AI authorship. It aims only to improve the accuracy and value of contributions where these tools are already used, reducing avoidable review work and CI load.
The guide was prepared by comparing current NUT contribution requirements with public maintainer feedback on AI-labelled pull requests. It retains only existing requirements which benefit from machine discovery or recurring publicly evidenced failure modes. Representative examples include driver-layer and sibling-precedent questions in #3502, review feedback about NUT helpers and distribution metadata in #3406, and distinguishing baseline or CI-environment failures from patch failures in #3560 and #3588. Existing project documentation remains authoritative.
Validation:
git diff --checkpassed.docs/developers.txtspellcheck passed../autogen.shand an out-of-tree configure with documentation enabled passed.make -s -j2 distcheck-lightwas not confirmed locally. Source archive generation, extracted build progress, andAGENTS.mdarchive membership were verified.NEWS.adocanddocs/man/apcmicrolink.txt, while the newdocs/developers.txtsentence passed its focused check.AI assistance: OpenAI Codex gpt-5.6-sol was used for research, drafting and review. The human contributor remains responsible for the change.